This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perlhacktips.pod: clarify -DDEBUG_LEAKING_SCALARS
[perl5.git] / gv.c
... / ...
CommitLineData
1/* gv.c
2 *
3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 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/*
12 * 'Mercy!' cried Gandalf. 'If the giving of information is to be the cure
13 * of your inquisitiveness, I shall spend all the rest of my days in answering
14 * you. What more do you want to know?'
15 * 'The names of all the stars, and of all living things, and the whole
16 * history of Middle-earth and Over-heaven and of the Sundering Seas,'
17 * laughed Pippin.
18 *
19 * [p.599 of _The Lord of the Rings_, III/xi: "The Palantír"]
20 */
21
22/*
23=head1 GV Functions
24A GV is a structure which corresponds to to a Perl typeglob, ie *foo.
25It is a structure that holds a pointer to a scalar, an array, a hash etc,
26corresponding to $foo, @foo, %foo.
27
28GVs are usually found as values in stashes (symbol table hashes) where
29Perl stores its global variables.
30
31=cut
32*/
33
34#include "EXTERN.h"
35#define PERL_IN_GV_C
36#include "perl.h"
37#include "overload.inc"
38#include "keywords.h"
39#include "feature.h"
40
41static const char S_autoload[] = "AUTOLOAD";
42#define S_autolen (sizeof("AUTOLOAD")-1)
43
44GV *
45Perl_gv_add_by_type(pTHX_ GV *gv, svtype type)
46{
47 SV **where;
48
49 if (
50 !gv
51 || (
52 SvTYPE((const SV *)gv) != SVt_PVGV
53 && SvTYPE((const SV *)gv) != SVt_PVLV
54 )
55 ) {
56 const char *what;
57 if (type == SVt_PVIO) {
58 /*
59 * if it walks like a dirhandle, then let's assume that
60 * this is a dirhandle.
61 */
62 what = OP_IS_DIRHOP(PL_op->op_type) ?
63 "dirhandle" : "filehandle";
64 } else if (type == SVt_PVHV) {
65 what = "hash";
66 } else {
67 what = type == SVt_PVAV ? "array" : "scalar";
68 }
69 /* diag_listed_as: Bad symbol for filehandle */
70 Perl_croak(aTHX_ "Bad symbol for %s", what);
71 }
72
73 if (type == SVt_PVHV) {
74 where = (SV **)&GvHV(gv);
75 } else if (type == SVt_PVAV) {
76 where = (SV **)&GvAV(gv);
77 } else if (type == SVt_PVIO) {
78 where = (SV **)&GvIOp(gv);
79 } else {
80 where = &GvSV(gv);
81 }
82
83 if (!*where)
84 {
85 *where = newSV_type(type);
86 if (type == SVt_PVAV && GvNAMELEN(gv) == 3
87 && strEQs(GvNAME(gv), "ISA"))
88 sv_magic(*where, (SV *)gv, PERL_MAGIC_isa, NULL, 0);
89 }
90 return gv;
91}
92
93GV *
94Perl_gv_fetchfile(pTHX_ const char *name)
95{
96 PERL_ARGS_ASSERT_GV_FETCHFILE;
97 return gv_fetchfile_flags(name, strlen(name), 0);
98}
99
100GV *
101Perl_gv_fetchfile_flags(pTHX_ const char *const name, const STRLEN namelen,
102 const U32 flags)
103{
104 char smallbuf[128];
105 char *tmpbuf;
106 const STRLEN tmplen = namelen + 2;
107 GV *gv;
108
109 PERL_ARGS_ASSERT_GV_FETCHFILE_FLAGS;
110 PERL_UNUSED_ARG(flags);
111
112 if (!PL_defstash)
113 return NULL;
114
115 if (tmplen <= sizeof smallbuf)
116 tmpbuf = smallbuf;
117 else
118 Newx(tmpbuf, tmplen, char);
119 /* This is where the debugger's %{"::_<$filename"} hash is created */
120 tmpbuf[0] = '_';
121 tmpbuf[1] = '<';
122 memcpy(tmpbuf + 2, name, namelen);
123 gv = *(GV**)hv_fetch(PL_defstash, tmpbuf, tmplen, TRUE);
124 if (!isGV(gv)) {
125 gv_init(gv, PL_defstash, tmpbuf, tmplen, FALSE);
126#ifdef PERL_DONT_CREATE_GVSV
127 GvSV(gv) = newSVpvn(name, namelen);
128#else
129 sv_setpvn(GvSV(gv), name, namelen);
130#endif
131 }
132 if (PERLDB_LINE_OR_SAVESRC && !GvAV(gv))
133 hv_magic(GvHVn(gv), GvAVn(gv), PERL_MAGIC_dbfile);
134 if (tmpbuf != smallbuf)
135 Safefree(tmpbuf);
136 return gv;
137}
138
139/*
140=for apidoc gv_const_sv
141
142If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
143inlining, or C<gv> is a placeholder reference that would be promoted to such
144a typeglob, then returns the value returned by the sub. Otherwise, returns
145C<NULL>.
146
147=cut
148*/
149
150SV *
151Perl_gv_const_sv(pTHX_ GV *gv)
152{
153 PERL_ARGS_ASSERT_GV_CONST_SV;
154 PERL_UNUSED_CONTEXT;
155
156 if (SvTYPE(gv) == SVt_PVGV)
157 return cv_const_sv(GvCVu(gv));
158 return SvROK(gv) && SvTYPE(SvRV(gv)) != SVt_PVAV && SvTYPE(SvRV(gv)) != SVt_PVCV ? SvRV(gv) : NULL;
159}
160
161GP *
162Perl_newGP(pTHX_ GV *const gv)
163{
164 GP *gp;
165 U32 hash;
166 const char *file;
167 STRLEN len;
168#ifndef USE_ITHREADS
169 GV *filegv;
170#endif
171 dVAR;
172
173 PERL_ARGS_ASSERT_NEWGP;
174 Newxz(gp, 1, GP);
175 gp->gp_egv = gv; /* allow compiler to reuse gv after this */
176#ifndef PERL_DONT_CREATE_GVSV
177 gp->gp_sv = newSV(0);
178#endif
179
180 /* PL_curcop may be null here. E.g.,
181 INIT { bless {} and exit }
182 frees INIT before looking up DESTROY (and creating *DESTROY)
183 */
184 if (PL_curcop) {
185 gp->gp_line = CopLINE(PL_curcop); /* 0 otherwise Newxz */
186#ifdef USE_ITHREADS
187 if (CopFILE(PL_curcop)) {
188 file = CopFILE(PL_curcop);
189 len = strlen(file);
190 }
191#else
192 filegv = CopFILEGV(PL_curcop);
193 if (filegv) {
194 file = GvNAME(filegv)+2;
195 len = GvNAMELEN(filegv)-2;
196 }
197#endif
198 else goto no_file;
199 }
200 else {
201 no_file:
202 file = "";
203 len = 0;
204 }
205
206 PERL_HASH(hash, file, len);
207 gp->gp_file_hek = share_hek(file, len, hash);
208 gp->gp_refcnt = 1;
209
210 return gp;
211}
212
213/* Assign CvGV(cv) = gv, handling weak references.
214 * See also S_anonymise_cv_maybe */
215
216void
217Perl_cvgv_set(pTHX_ CV* cv, GV* gv)
218{
219 GV * const oldgv = CvNAMED(cv) ? NULL : SvANY(cv)->xcv_gv_u.xcv_gv;
220 HEK *hek;
221 PERL_ARGS_ASSERT_CVGV_SET;
222
223 if (oldgv == gv)
224 return;
225
226 if (oldgv) {
227 if (CvCVGV_RC(cv)) {
228 SvREFCNT_dec_NN(oldgv);
229 CvCVGV_RC_off(cv);
230 }
231 else {
232 sv_del_backref(MUTABLE_SV(oldgv), MUTABLE_SV(cv));
233 }
234 }
235 else if ((hek = CvNAME_HEK(cv))) {
236 unshare_hek(hek);
237 CvLEXICAL_off(cv);
238 }
239
240 CvNAMED_off(cv);
241 SvANY(cv)->xcv_gv_u.xcv_gv = gv;
242 assert(!CvCVGV_RC(cv));
243
244 if (!gv)
245 return;
246
247 if (isGV_with_GP(gv) && GvGP(gv) && (GvCV(gv) == cv || GvFORM(gv) == cv))
248 Perl_sv_add_backref(aTHX_ MUTABLE_SV(gv), MUTABLE_SV(cv));
249 else {
250 CvCVGV_RC_on(cv);
251 SvREFCNT_inc_simple_void_NN(gv);
252 }
253}
254
255/* Convert CvSTASH + CvNAME_HEK into a GV. Conceptually, all subs have a
256 GV, but for efficiency that GV may not in fact exist. This function,
257 called by CvGV, reifies it. */
258
259GV *
260Perl_cvgv_from_hek(pTHX_ CV *cv)
261{
262 GV *gv;
263 SV **svp;
264 PERL_ARGS_ASSERT_CVGV_FROM_HEK;
265 assert(SvTYPE(cv) == SVt_PVCV);
266 if (!CvSTASH(cv)) return NULL;
267 ASSUME(CvNAME_HEK(cv));
268 svp = hv_fetchhek(CvSTASH(cv), CvNAME_HEK(cv), 0);
269 gv = MUTABLE_GV(svp && *svp ? *svp : newSV(0));
270 if (!isGV(gv))
271 gv_init_pvn(gv, CvSTASH(cv), HEK_KEY(CvNAME_HEK(cv)),
272 HEK_LEN(CvNAME_HEK(cv)),
273 SVf_UTF8 * !!HEK_UTF8(CvNAME_HEK(cv)));
274 if (!CvNAMED(cv)) { /* gv_init took care of it */
275 assert (SvANY(cv)->xcv_gv_u.xcv_gv == gv);
276 return gv;
277 }
278 unshare_hek(CvNAME_HEK(cv));
279 CvNAMED_off(cv);
280 SvANY(cv)->xcv_gv_u.xcv_gv = gv;
281 if (svp && *svp) SvREFCNT_inc_simple_void_NN(gv);
282 CvCVGV_RC_on(cv);
283 return gv;
284}
285
286/* Assign CvSTASH(cv) = st, handling weak references. */
287
288void
289Perl_cvstash_set(pTHX_ CV *cv, HV *st)
290{
291 HV *oldst = CvSTASH(cv);
292 PERL_ARGS_ASSERT_CVSTASH_SET;
293 if (oldst == st)
294 return;
295 if (oldst)
296 sv_del_backref(MUTABLE_SV(oldst), MUTABLE_SV(cv));
297 SvANY(cv)->xcv_stash = st;
298 if (st)
299 Perl_sv_add_backref(aTHX_ MUTABLE_SV(st), MUTABLE_SV(cv));
300}
301
302/*
303=for apidoc gv_init_pvn
304
305Converts a scalar into a typeglob. This is an incoercible typeglob;
306assigning a reference to it will assign to one of its slots, instead of
307overwriting it as happens with typeglobs created by C<SvSetSV>. Converting
308any scalar that is C<SvOK()> may produce unpredictable results and is reserved
309for perl's internal use.
310
311C<gv> is the scalar to be converted.
312
313C<stash> is the parent stash/package, if any.
314
315C<name> and C<len> give the name. The name must be unqualified;
316that is, it must not include the package name. If C<gv> is a
317stash element, it is the caller's responsibility to ensure that the name
318passed to this function matches the name of the element. If it does not
319match, perl's internal bookkeeping will get out of sync.
320
321C<flags> can be set to C<SVf_UTF8> if C<name> is a UTF-8 string, or
322the return value of SvUTF8(sv). It can also take the
323C<GV_ADDMULTI> flag, which means to pretend that the GV has been
324seen before (i.e., suppress "Used once" warnings).
325
326=for apidoc gv_init
327
328The old form of C<gv_init_pvn()>. It does not work with UTF-8 strings, as it
329has no flags parameter. If the C<multi> parameter is set, the
330C<GV_ADDMULTI> flag will be passed to C<gv_init_pvn()>.
331
332=for apidoc gv_init_pv
333
334Same as C<gv_init_pvn()>, but takes a nul-terminated string for the name
335instead of separate char * and length parameters.
336
337=for apidoc gv_init_sv
338
339Same as C<gv_init_pvn()>, but takes an SV * for the name instead of separate
340char * and length parameters. C<flags> is currently unused.
341
342=cut
343*/
344
345void
346Perl_gv_init_sv(pTHX_ GV *gv, HV *stash, SV* namesv, U32 flags)
347{
348 char *namepv;
349 STRLEN namelen;
350 PERL_ARGS_ASSERT_GV_INIT_SV;
351 namepv = SvPV(namesv, namelen);
352 if (SvUTF8(namesv))
353 flags |= SVf_UTF8;
354 gv_init_pvn(gv, stash, namepv, namelen, flags);
355}
356
357void
358Perl_gv_init_pv(pTHX_ GV *gv, HV *stash, const char *name, U32 flags)
359{
360 PERL_ARGS_ASSERT_GV_INIT_PV;
361 gv_init_pvn(gv, stash, name, strlen(name), flags);
362}
363
364void
365Perl_gv_init_pvn(pTHX_ GV *gv, HV *stash, const char *name, STRLEN len, U32 flags)
366{
367 const U32 old_type = SvTYPE(gv);
368 const bool doproto = old_type > SVt_NULL;
369 char * const proto = (doproto && SvPOK(gv))
370 ? ((void)(SvIsCOW(gv) && (sv_force_normal((SV *)gv), 0)), SvPVX(gv))
371 : NULL;
372 const STRLEN protolen = proto ? SvCUR(gv) : 0;
373 const U32 proto_utf8 = proto ? SvUTF8(gv) : 0;
374 SV *const has_constant = doproto && SvROK(gv) ? SvRV(gv) : NULL;
375 const U32 exported_constant = has_constant ? SvPCS_IMPORTED(gv) : 0;
376
377 PERL_ARGS_ASSERT_GV_INIT_PVN;
378 assert (!(proto && has_constant));
379
380 if (has_constant) {
381 /* The constant has to be a scalar, array or subroutine. */
382 switch (SvTYPE(has_constant)) {
383 case SVt_PVHV:
384 case SVt_PVFM:
385 case SVt_PVIO:
386 Perl_croak(aTHX_ "Cannot convert a reference to %s to typeglob",
387 sv_reftype(has_constant, 0));
388 break;
389
390 default: NOOP;
391 }
392 SvRV_set(gv, NULL);
393 SvROK_off(gv);
394 }
395
396
397 if (old_type < SVt_PVGV) {
398 if (old_type >= SVt_PV)
399 SvCUR_set(gv, 0);
400 sv_upgrade(MUTABLE_SV(gv), SVt_PVGV);
401 }
402 if (SvLEN(gv)) {
403 if (proto) {
404 SvPV_set(gv, NULL);
405 SvLEN_set(gv, 0);
406 SvPOK_off(gv);
407 } else
408 Safefree(SvPVX_mutable(gv));
409 }
410 SvIOK_off(gv);
411 isGV_with_GP_on(gv);
412
413 GvGP_set(gv, Perl_newGP(aTHX_ gv));
414 GvSTASH(gv) = stash;
415 if (stash)
416 Perl_sv_add_backref(aTHX_ MUTABLE_SV(stash), MUTABLE_SV(gv));
417 gv_name_set(gv, name, len, GV_ADD | ( flags & SVf_UTF8 ? SVf_UTF8 : 0 ));
418 if (flags & GV_ADDMULTI || doproto) /* doproto means it */
419 GvMULTI_on(gv); /* _was_ mentioned */
420 if (has_constant && SvTYPE(has_constant) == SVt_PVCV) {
421 /* Not actually a constant. Just a regular sub. */
422 CV * const cv = (CV *)has_constant;
423 GvCV_set(gv,cv);
424 if (CvSTASH(cv) == stash && (
425 CvNAME_HEK(cv) == GvNAME_HEK(gv)
426 || ( HEK_LEN(CvNAME_HEK(cv)) == HEK_LEN(GvNAME_HEK(gv))
427 && HEK_FLAGS(CvNAME_HEK(cv)) != HEK_FLAGS(GvNAME_HEK(gv))
428 && HEK_UTF8(CvNAME_HEK(cv)) == HEK_UTF8(GvNAME_HEK(gv))
429 && memEQ(HEK_KEY(CvNAME_HEK(cv)), GvNAME(gv), GvNAMELEN(gv))
430 )
431 ))
432 CvGV_set(cv,gv);
433 }
434 else if (doproto) {
435 CV *cv;
436 if (has_constant) {
437 /* newCONSTSUB takes ownership of the reference from us. */
438 cv = newCONSTSUB_flags(stash, name, len, flags, has_constant);
439 /* In case op.c:S_process_special_blocks stole it: */
440 if (!GvCV(gv))
441 GvCV_set(gv, (CV *)SvREFCNT_inc_simple_NN(cv));
442 assert(GvCV(gv) == cv); /* newCONSTSUB should have set this */
443 /* If this reference was a copy of another, then the subroutine
444 must have been "imported", by a Perl space assignment to a GV
445 from a reference to CV. */
446 if (exported_constant)
447 GvIMPORTED_CV_on(gv);
448 CvSTASH_set(cv, PL_curstash); /* XXX Why is this needed? */
449 } else {
450 cv = newSTUB(gv,1);
451 }
452 if (proto) {
453 sv_usepvn_flags(MUTABLE_SV(cv), proto, protolen,
454 SV_HAS_TRAILING_NUL);
455 if ( proto_utf8 ) SvUTF8_on(MUTABLE_SV(cv));
456 }
457 }
458}
459
460STATIC void
461S_gv_init_svtype(pTHX_ GV *gv, const svtype sv_type)
462{
463 PERL_ARGS_ASSERT_GV_INIT_SVTYPE;
464
465 switch (sv_type) {
466 case SVt_PVIO:
467 (void)GvIOn(gv);
468 break;
469 case SVt_PVAV:
470 (void)GvAVn(gv);
471 break;
472 case SVt_PVHV:
473 (void)GvHVn(gv);
474 break;
475#ifdef PERL_DONT_CREATE_GVSV
476 case SVt_NULL:
477 case SVt_PVCV:
478 case SVt_PVFM:
479 case SVt_PVGV:
480 break;
481 default:
482 if(GvSVn(gv)) {
483 /* Work round what appears to be a bug in Sun C++ 5.8 2005/10/13
484 If we just cast GvSVn(gv) to void, it ignores evaluating it for
485 its side effect */
486 }
487#endif
488 }
489}
490
491static void core_xsub(pTHX_ CV* cv);
492
493static GV *
494S_maybe_add_coresub(pTHX_ HV * const stash, GV *gv,
495 const char * const name, const STRLEN len)
496{
497 const int code = keyword(name, len, 1);
498 static const char file[] = __FILE__;
499 CV *cv, *oldcompcv = NULL;
500 int opnum = 0;
501 bool ampable = TRUE; /* &{}-able */
502 COP *oldcurcop = NULL;
503 yy_parser *oldparser = NULL;
504 I32 oldsavestack_ix = 0;
505
506 assert(gv || stash);
507 assert(name);
508
509 if (!code) return NULL; /* Not a keyword */
510 switch (code < 0 ? -code : code) {
511 /* no support for \&CORE::infix;
512 no support for funcs that do not parse like funcs */
513 case KEY___DATA__: case KEY___END__: case KEY_and: case KEY_AUTOLOAD:
514 case KEY_BEGIN : case KEY_CHECK : case KEY_cmp:
515 case KEY_default : case KEY_DESTROY:
516 case KEY_do : case KEY_dump : case KEY_else : case KEY_elsif :
517 case KEY_END : case KEY_eq : case KEY_eval :
518 case KEY_for : case KEY_foreach: case KEY_format: case KEY_ge :
519 case KEY_given : case KEY_goto : case KEY_grep :
520 case KEY_gt : case KEY_if: case KEY_INIT: case KEY_last: case KEY_le:
521 case KEY_local: case KEY_lt: case KEY_m : case KEY_map : case KEY_my:
522 case KEY_ne : case KEY_next : case KEY_no: case KEY_or: case KEY_our:
523 case KEY_package: case KEY_print: case KEY_printf:
524 case KEY_q : case KEY_qq : case KEY_qr : case KEY_qw :
525 case KEY_qx : case KEY_redo : case KEY_require: case KEY_return:
526 case KEY_s : case KEY_say : case KEY_sort :
527 case KEY_state: case KEY_sub :
528 case KEY_tr : case KEY_UNITCHECK: case KEY_unless:
529 case KEY_until: case KEY_use : case KEY_when : case KEY_while :
530 case KEY_x : case KEY_xor : case KEY_y :
531 return NULL;
532 case KEY_chdir:
533 case KEY_chomp: case KEY_chop: case KEY_defined: case KEY_delete:
534 case KEY_eof : case KEY_exec: case KEY_exists :
535 case KEY_lstat:
536 case KEY_split:
537 case KEY_stat:
538 case KEY_system:
539 case KEY_truncate: case KEY_unlink:
540 ampable = FALSE;
541 }
542 if (!gv) {
543 gv = (GV *)newSV(0);
544 gv_init(gv, stash, name, len, TRUE);
545 }
546 GvMULTI_on(gv);
547 if (ampable) {
548 ENTER;
549 oldcurcop = PL_curcop;
550 oldparser = PL_parser;
551 lex_start(NULL, NULL, 0);
552 oldcompcv = PL_compcv;
553 PL_compcv = NULL; /* Prevent start_subparse from setting
554 CvOUTSIDE. */
555 oldsavestack_ix = start_subparse(FALSE,0);
556 cv = PL_compcv;
557 }
558 else {
559 /* Avoid calling newXS, as it calls us, and things start to
560 get hairy. */
561 cv = MUTABLE_CV(newSV_type(SVt_PVCV));
562 GvCV_set(gv,cv);
563 GvCVGEN(gv) = 0;
564 CvISXSUB_on(cv);
565 CvXSUB(cv) = core_xsub;
566 PoisonPADLIST(cv);
567 }
568 CvGV_set(cv, gv); /* This stops new ATTRSUB from setting CvFILE
569 from PL_curcop. */
570 /* XSUBs can't be perl lang/perl5db.pl debugged
571 if (PERLDB_LINE_OR_SAVESRC)
572 (void)gv_fetchfile(file); */
573 CvFILE(cv) = (char *)file;
574 /* XXX This is inefficient, as doing things this order causes
575 a prototype check in newATTRSUB. But we have to do
576 it this order as we need an op number before calling
577 new ATTRSUB. */
578 (void)core_prototype((SV *)cv, name, code, &opnum);
579 if (stash)
580 (void)hv_store(stash,name,len,(SV *)gv,0);
581 if (ampable) {
582#ifdef DEBUGGING
583 CV *orig_cv = cv;
584#endif
585 CvLVALUE_on(cv);
586 /* newATTRSUB will free the CV and return NULL if we're still
587 compiling after a syntax error */
588 if ((cv = newATTRSUB_x(
589 oldsavestack_ix, (OP *)gv,
590 NULL,NULL,
591 coresub_op(
592 opnum
593 ? newSVuv((UV)opnum)
594 : newSVpvn(name,len),
595 code, opnum
596 ),
597 TRUE
598 )) != NULL) {
599 assert(GvCV(gv) == orig_cv);
600 if (opnum != OP_VEC && opnum != OP_SUBSTR && opnum != OP_POS
601 && opnum != OP_UNDEF && opnum != OP_KEYS)
602 CvLVALUE_off(cv); /* Now *that* was a neat trick. */
603 }
604 LEAVE;
605 PL_parser = oldparser;
606 PL_curcop = oldcurcop;
607 PL_compcv = oldcompcv;
608 }
609 if (cv) {
610 SV *opnumsv = opnum ? newSVuv((UV)opnum) : (SV *)NULL;
611 cv_set_call_checker(
612 cv, Perl_ck_entersub_args_core, opnumsv ? opnumsv : (SV *)cv
613 );
614 SvREFCNT_dec(opnumsv);
615 }
616
617 return gv;
618}
619
620/*
621=for apidoc gv_fetchmeth
622
623Like L</gv_fetchmeth_pvn>, but lacks a flags parameter.
624
625=for apidoc gv_fetchmeth_sv
626
627Exactly like L</gv_fetchmeth_pvn>, but takes the name string in the form
628of an SV instead of a string/length pair.
629
630=cut
631*/
632
633GV *
634Perl_gv_fetchmeth_sv(pTHX_ HV *stash, SV *namesv, I32 level, U32 flags)
635{
636 char *namepv;
637 STRLEN namelen;
638 PERL_ARGS_ASSERT_GV_FETCHMETH_SV;
639 if (LIKELY(SvPOK_nog(namesv))) /* common case */
640 return gv_fetchmeth_internal(stash, namesv, NULL, 0, level, flags);
641 namepv = SvPV(namesv, namelen);
642 if (SvUTF8(namesv)) flags |= SVf_UTF8;
643 return gv_fetchmeth_pvn(stash, namepv, namelen, level, flags);
644}
645
646/*
647=for apidoc gv_fetchmeth_pv
648
649Exactly like L</gv_fetchmeth_pvn>, but takes a nul-terminated string
650instead of a string/length pair.
651
652=cut
653*/
654
655GV *
656Perl_gv_fetchmeth_pv(pTHX_ HV *stash, const char *name, I32 level, U32 flags)
657{
658 PERL_ARGS_ASSERT_GV_FETCHMETH_PV;
659 return gv_fetchmeth_internal(stash, NULL, name, strlen(name), level, flags);
660}
661
662/*
663=for apidoc gv_fetchmeth_pvn
664
665Returns the glob with the given C<name> and a defined subroutine or
666C<NULL>. The glob lives in the given C<stash>, or in the stashes
667accessible via C<@ISA> and C<UNIVERSAL::>.
668
669The argument C<level> should be either 0 or -1. If C<level==0>, as a
670side-effect creates a glob with the given C<name> in the given C<stash>
671which in the case of success contains an alias for the subroutine, and sets
672up caching info for this glob.
673
674The only significant values for C<flags> are C<GV_SUPER> and C<SVf_UTF8>.
675
676C<GV_SUPER> indicates that we want to look up the method in the superclasses
677of the C<stash>.
678
679The
680GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
681visible to Perl code. So when calling C<call_sv>, you should not use
682the GV directly; instead, you should use the method's CV, which can be
683obtained from the GV with the C<GvCV> macro.
684
685=cut
686*/
687
688/* NOTE: No support for tied ISA */
689
690PERL_STATIC_INLINE GV*
691S_gv_fetchmeth_internal(pTHX_ HV* stash, SV* meth, const char* name, STRLEN len, I32 level, U32 flags)
692{
693 GV** gvp;
694 HE* he;
695 AV* linear_av;
696 SV** linear_svp;
697 SV* linear_sv;
698 HV* cstash, *cachestash;
699 GV* candidate = NULL;
700 CV* cand_cv = NULL;
701 GV* topgv = NULL;
702 const char *hvname;
703 I32 create = (level >= 0) ? HV_FETCH_LVALUE : 0;
704 I32 items;
705 U32 topgen_cmp;
706 U32 is_utf8 = flags & SVf_UTF8;
707
708 /* UNIVERSAL methods should be callable without a stash */
709 if (!stash) {
710 create = 0; /* probably appropriate */
711 if(!(stash = gv_stashpvs("UNIVERSAL", 0)))
712 return 0;
713 }
714
715 assert(stash);
716
717 hvname = HvNAME_get(stash);
718 if (!hvname)
719 Perl_croak(aTHX_ "Can't use anonymous symbol table for method lookup");
720
721 assert(hvname);
722 assert(name || meth);
723
724 DEBUG_o( Perl_deb(aTHX_ "Looking for %smethod %s in package %s\n",
725 flags & GV_SUPER ? "SUPER " : "",
726 name ? name : SvPV_nolen(meth), hvname) );
727
728 topgen_cmp = HvMROMETA(stash)->cache_gen + PL_sub_generation;
729
730 if (flags & GV_SUPER) {
731 if (!HvAUX(stash)->xhv_mro_meta->super)
732 HvAUX(stash)->xhv_mro_meta->super = newHV();
733 cachestash = HvAUX(stash)->xhv_mro_meta->super;
734 }
735 else cachestash = stash;
736
737 /* check locally for a real method or a cache entry */
738 he = (HE*)hv_common(
739 cachestash, meth, name, len, is_utf8 ? HVhek_UTF8 : 0, create, NULL, 0
740 );
741 if (he) gvp = (GV**)&HeVAL(he);
742 else gvp = NULL;
743
744 if(gvp) {
745 topgv = *gvp;
746 have_gv:
747 assert(topgv);
748 if (SvTYPE(topgv) != SVt_PVGV)
749 {
750 if (!name)
751 name = SvPV_nomg(meth, len);
752 gv_init_pvn(topgv, stash, name, len, GV_ADDMULTI|is_utf8);
753 }
754 if ((cand_cv = GvCV(topgv))) {
755 /* If genuine method or valid cache entry, use it */
756 if (!GvCVGEN(topgv) || GvCVGEN(topgv) == topgen_cmp) {
757 return topgv;
758 }
759 else {
760 /* stale cache entry, junk it and move on */
761 SvREFCNT_dec_NN(cand_cv);
762 GvCV_set(topgv, NULL);
763 cand_cv = NULL;
764 GvCVGEN(topgv) = 0;
765 }
766 }
767 else if (GvCVGEN(topgv) == topgen_cmp) {
768 /* cache indicates no such method definitively */
769 return 0;
770 }
771 else if (stash == cachestash
772 && len > 1 /* shortest is uc */ && HvNAMELEN_get(stash) == 4
773 && strEQs(hvname, "CORE")
774 && S_maybe_add_coresub(aTHX_ NULL,topgv,name,len))
775 goto have_gv;
776 }
777
778 linear_av = mro_get_linear_isa(stash); /* has ourselves at the top of the list */
779 linear_svp = AvARRAY(linear_av) + 1; /* skip over self */
780 items = AvFILLp(linear_av); /* no +1, to skip over self */
781 while (items--) {
782 linear_sv = *linear_svp++;
783 assert(linear_sv);
784 cstash = gv_stashsv(linear_sv, 0);
785
786 if (!cstash) {
787 Perl_ck_warner(aTHX_ packWARN(WARN_SYNTAX),
788 "Can't locate package %" SVf " for @%" HEKf "::ISA",
789 SVfARG(linear_sv),
790 HEKfARG(HvNAME_HEK(stash)));
791 continue;
792 }
793
794 assert(cstash);
795
796 gvp = (GV**)hv_fetch(cstash, name, is_utf8 ? -(I32)len : (I32)len, 0);
797 if (!gvp) {
798 if (len > 1 && HvNAMELEN_get(cstash) == 4) {
799 const char *hvname = HvNAME(cstash); assert(hvname);
800 if (strEQs(hvname, "CORE")
801 && (candidate =
802 S_maybe_add_coresub(aTHX_ cstash,NULL,name,len)
803 ))
804 goto have_candidate;
805 }
806 continue;
807 }
808 else candidate = *gvp;
809 have_candidate:
810 assert(candidate);
811 if (SvTYPE(candidate) != SVt_PVGV)
812 gv_init_pvn(candidate, cstash, name, len, GV_ADDMULTI|is_utf8);
813 if (SvTYPE(candidate) == SVt_PVGV && (cand_cv = GvCV(candidate)) && !GvCVGEN(candidate)) {
814 /*
815 * Found real method, cache method in topgv if:
816 * 1. topgv has no synonyms (else inheritance crosses wires)
817 * 2. method isn't a stub (else AUTOLOAD fails spectacularly)
818 */
819 if (topgv && (GvREFCNT(topgv) == 1) && (CvROOT(cand_cv) || CvXSUB(cand_cv))) {
820 CV *old_cv = GvCV(topgv);
821 SvREFCNT_dec(old_cv);
822 SvREFCNT_inc_simple_void_NN(cand_cv);
823 GvCV_set(topgv, cand_cv);
824 GvCVGEN(topgv) = topgen_cmp;
825 }
826 return candidate;
827 }
828 }
829
830 /* Check UNIVERSAL without caching */
831 if(level == 0 || level == -1) {
832 candidate = gv_fetchmeth_internal(NULL, meth, name, len, 1,
833 flags &~GV_SUPER);
834 if(candidate) {
835 cand_cv = GvCV(candidate);
836 if (topgv && (GvREFCNT(topgv) == 1) && (CvROOT(cand_cv) || CvXSUB(cand_cv))) {
837 CV *old_cv = GvCV(topgv);
838 SvREFCNT_dec(old_cv);
839 SvREFCNT_inc_simple_void_NN(cand_cv);
840 GvCV_set(topgv, cand_cv);
841 GvCVGEN(topgv) = topgen_cmp;
842 }
843 return candidate;
844 }
845 }
846
847 if (topgv && GvREFCNT(topgv) == 1) {
848 /* cache the fact that the method is not defined */
849 GvCVGEN(topgv) = topgen_cmp;
850 }
851
852 return 0;
853}
854
855GV *
856Perl_gv_fetchmeth_pvn(pTHX_ HV *stash, const char *name, STRLEN len, I32 level, U32 flags)
857{
858 PERL_ARGS_ASSERT_GV_FETCHMETH_PVN;
859 return gv_fetchmeth_internal(stash, NULL, name, len, level, flags);
860}
861
862/*
863=for apidoc gv_fetchmeth_autoload
864
865This is the old form of L</gv_fetchmeth_pvn_autoload>, which has no flags
866parameter.
867
868=for apidoc gv_fetchmeth_sv_autoload
869
870Exactly like L</gv_fetchmeth_pvn_autoload>, but takes the name string in the form
871of an SV instead of a string/length pair.
872
873=cut
874*/
875
876GV *
877Perl_gv_fetchmeth_sv_autoload(pTHX_ HV *stash, SV *namesv, I32 level, U32 flags)
878{
879 char *namepv;
880 STRLEN namelen;
881 PERL_ARGS_ASSERT_GV_FETCHMETH_SV_AUTOLOAD;
882 namepv = SvPV(namesv, namelen);
883 if (SvUTF8(namesv))
884 flags |= SVf_UTF8;
885 return gv_fetchmeth_pvn_autoload(stash, namepv, namelen, level, flags);
886}
887
888/*
889=for apidoc gv_fetchmeth_pv_autoload
890
891Exactly like L</gv_fetchmeth_pvn_autoload>, but takes a nul-terminated string
892instead of a string/length pair.
893
894=cut
895*/
896
897GV *
898Perl_gv_fetchmeth_pv_autoload(pTHX_ HV *stash, const char *name, I32 level, U32 flags)
899{
900 PERL_ARGS_ASSERT_GV_FETCHMETH_PV_AUTOLOAD;
901 return gv_fetchmeth_pvn_autoload(stash, name, strlen(name), level, flags);
902}
903
904/*
905=for apidoc gv_fetchmeth_pvn_autoload
906
907Same as C<gv_fetchmeth_pvn()>, but looks for autoloaded subroutines too.
908Returns a glob for the subroutine.
909
910For an autoloaded subroutine without a GV, will create a GV even
911if C<level < 0>. For an autoloaded subroutine without a stub, C<GvCV()>
912of the result may be zero.
913
914Currently, the only significant value for C<flags> is C<SVf_UTF8>.
915
916=cut
917*/
918
919GV *
920Perl_gv_fetchmeth_pvn_autoload(pTHX_ HV *stash, const char *name, STRLEN len, I32 level, U32 flags)
921{
922 GV *gv = gv_fetchmeth_pvn(stash, name, len, level, flags);
923
924 PERL_ARGS_ASSERT_GV_FETCHMETH_PVN_AUTOLOAD;
925
926 if (!gv) {
927 CV *cv;
928 GV **gvp;
929
930 if (!stash)
931 return NULL; /* UNIVERSAL::AUTOLOAD could cause trouble */
932 if (len == S_autolen && memEQ(name, S_autoload, S_autolen))
933 return NULL;
934 if (!(gv = gv_fetchmeth_pvn(stash, S_autoload, S_autolen, FALSE, flags)))
935 return NULL;
936 cv = GvCV(gv);
937 if (!(CvROOT(cv) || CvXSUB(cv)))
938 return NULL;
939 /* Have an autoload */
940 if (level < 0) /* Cannot do without a stub */
941 gv_fetchmeth_pvn(stash, name, len, 0, flags);
942 gvp = (GV**)hv_fetch(stash, name,
943 (flags & SVf_UTF8) ? -(I32)len : (I32)len, (level >= 0));
944 if (!gvp)
945 return NULL;
946 return *gvp;
947 }
948 return gv;
949}
950
951/*
952=for apidoc gv_fetchmethod_autoload
953
954Returns the glob which contains the subroutine to call to invoke the method
955on the C<stash>. In fact in the presence of autoloading this may be the
956glob for "AUTOLOAD". In this case the corresponding variable C<$AUTOLOAD> is
957already setup.
958
959The third parameter of C<gv_fetchmethod_autoload> determines whether
960AUTOLOAD lookup is performed if the given method is not present: non-zero
961means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
962Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
963with a non-zero C<autoload> parameter.
964
965These functions grant C<"SUPER"> token
966as a prefix of the method name. Note
967that if you want to keep the returned glob for a long time, you need to
968check for it being "AUTOLOAD", since at the later time the call may load a
969different subroutine due to C<$AUTOLOAD> changing its value. Use the glob
970created as a side effect to do this.
971
972These functions have the same side-effects as C<gv_fetchmeth> with
973C<level==0>. The warning against passing the GV returned by
974C<gv_fetchmeth> to C<call_sv> applies equally to these functions.
975
976=cut
977*/
978
979GV *
980Perl_gv_fetchmethod_autoload(pTHX_ HV *stash, const char *name, I32 autoload)
981{
982 PERL_ARGS_ASSERT_GV_FETCHMETHOD_AUTOLOAD;
983
984 return gv_fetchmethod_flags(stash, name, autoload ? GV_AUTOLOAD : 0);
985}
986
987GV *
988Perl_gv_fetchmethod_sv_flags(pTHX_ HV *stash, SV *namesv, U32 flags)
989{
990 char *namepv;
991 STRLEN namelen;
992 PERL_ARGS_ASSERT_GV_FETCHMETHOD_SV_FLAGS;
993 namepv = SvPV(namesv, namelen);
994 if (SvUTF8(namesv))
995 flags |= SVf_UTF8;
996 return gv_fetchmethod_pvn_flags(stash, namepv, namelen, flags);
997}
998
999GV *
1000Perl_gv_fetchmethod_pv_flags(pTHX_ HV *stash, const char *name, U32 flags)
1001{
1002 PERL_ARGS_ASSERT_GV_FETCHMETHOD_PV_FLAGS;
1003 return gv_fetchmethod_pvn_flags(stash, name, strlen(name), flags);
1004}
1005
1006GV *
1007Perl_gv_fetchmethod_pvn_flags(pTHX_ HV *stash, const char *name, const STRLEN len, U32 flags)
1008{
1009 const char * const origname = name;
1010 const char * const name_end = name + len;
1011 const char *last_separator = NULL;
1012 GV* gv;
1013 HV* ostash = stash;
1014 SV *const error_report = MUTABLE_SV(stash);
1015 const U32 autoload = flags & GV_AUTOLOAD;
1016 const U32 do_croak = flags & GV_CROAK;
1017 const U32 is_utf8 = flags & SVf_UTF8;
1018
1019 PERL_ARGS_ASSERT_GV_FETCHMETHOD_PVN_FLAGS;
1020
1021 if (SvTYPE(stash) < SVt_PVHV)
1022 stash = NULL;
1023 else {
1024 /* The only way stash can become NULL later on is if last_separator is set,
1025 which in turn means that there is no need for a SVt_PVHV case
1026 the error reporting code. */
1027 }
1028
1029 {
1030 /* check if the method name is fully qualified or
1031 * not, and separate the package name from the actual
1032 * method name.
1033 *
1034 * leaves last_separator pointing to the beginning of the
1035 * last package separator (either ' or ::) or 0
1036 * if none was found.
1037 *
1038 * leaves name pointing at the beginning of the
1039 * method name.
1040 */
1041 const char *name_cursor = name;
1042 const char * const name_em1 = name_end - 1; /* name_end minus 1 */
1043 for (name_cursor = name; name_cursor < name_end ; name_cursor++) {
1044 if (*name_cursor == '\'') {
1045 last_separator = name_cursor;
1046 name = name_cursor + 1;
1047 }
1048 else if (name_cursor < name_em1 && *name_cursor == ':' && name_cursor[1] == ':') {
1049 last_separator = name_cursor++;
1050 name = name_cursor + 1;
1051 }
1052 }
1053 }
1054
1055 /* did we find a separator? */
1056 if (last_separator) {
1057 STRLEN sep_len= last_separator - origname;
1058 if ( memEQs(origname, sep_len, "SUPER")) {
1059 /* ->SUPER::method should really be looked up in original stash */
1060 stash = CopSTASH(PL_curcop);
1061 flags |= GV_SUPER;
1062 DEBUG_o( Perl_deb(aTHX_ "Treating %s as %s::%s\n",
1063 origname, HvENAME_get(stash), name) );
1064 }
1065 else if ( sep_len >= 7 &&
1066 strEQs(last_separator - 7, "::SUPER")) {
1067 /* don't autovifify if ->NoSuchStash::SUPER::method */
1068 stash = gv_stashpvn(origname, sep_len - 7, is_utf8);
1069 if (stash) flags |= GV_SUPER;
1070 }
1071 else {
1072 /* don't autovifify if ->NoSuchStash::method */
1073 stash = gv_stashpvn(origname, sep_len, is_utf8);
1074 }
1075 ostash = stash;
1076 }
1077
1078 gv = gv_fetchmeth_pvn(stash, name, name_end - name, 0, flags);
1079 if (!gv) {
1080 /* This is the special case that exempts Foo->import and
1081 Foo->unimport from being an error even if there's no
1082 import/unimport subroutine */
1083 if (strEQ(name,"import") || strEQ(name,"unimport"))
1084 gv = MUTABLE_GV(&PL_sv_yes);
1085 else if (autoload)
1086 gv = gv_autoload_pvn(
1087 ostash, name, name_end - name, GV_AUTOLOAD_ISMETHOD|flags
1088 );
1089 if (!gv && do_croak) {
1090 /* Right now this is exclusively for the benefit of S_method_common
1091 in pp_hot.c */
1092 if (stash) {
1093 /* If we can't find an IO::File method, it might be a call on
1094 * a filehandle. If IO:File has not been loaded, try to
1095 * require it first instead of croaking */
1096 const char *stash_name = HvNAME_get(stash);
1097 if (stash_name && memEQs(stash_name, HvNAMELEN_get(stash), "IO::File")
1098 && !Perl_hv_common(aTHX_ GvHVn(PL_incgv), NULL,
1099 STR_WITH_LEN("IO/File.pm"), 0,
1100 HV_FETCH_ISEXISTS, NULL, 0)
1101 ) {
1102 require_pv("IO/File.pm");
1103 gv = gv_fetchmeth_pvn(stash, name, name_end - name, 0, flags);
1104 if (gv)
1105 return gv;
1106 }
1107 Perl_croak(aTHX_
1108 "Can't locate object method \"%" UTF8f
1109 "\" via package \"%" HEKf "\"",
1110 UTF8fARG(is_utf8, name_end - name, name),
1111 HEKfARG(HvNAME_HEK(stash)));
1112 }
1113 else {
1114 SV* packnamesv;
1115
1116 if (last_separator) {
1117 packnamesv = newSVpvn_flags(origname, last_separator - origname,
1118 SVs_TEMP | is_utf8);
1119 } else {
1120 packnamesv = error_report;
1121 }
1122
1123 Perl_croak(aTHX_
1124 "Can't locate object method \"%" UTF8f
1125 "\" via package \"%" SVf "\""
1126 " (perhaps you forgot to load \"%" SVf "\"?)",
1127 UTF8fARG(is_utf8, name_end - name, name),
1128 SVfARG(packnamesv), SVfARG(packnamesv));
1129 }
1130 }
1131 }
1132 else if (autoload) {
1133 CV* const cv = GvCV(gv);
1134 if (!CvROOT(cv) && !CvXSUB(cv)) {
1135 GV* stubgv;
1136 GV* autogv;
1137
1138 if (CvANON(cv) || CvLEXICAL(cv))
1139 stubgv = gv;
1140 else {
1141 stubgv = CvGV(cv);
1142 if (GvCV(stubgv) != cv) /* orphaned import */
1143 stubgv = gv;
1144 }
1145 autogv = gv_autoload_pvn(GvSTASH(stubgv),
1146 GvNAME(stubgv), GvNAMELEN(stubgv),
1147 GV_AUTOLOAD_ISMETHOD
1148 | (GvNAMEUTF8(stubgv) ? SVf_UTF8 : 0));
1149 if (autogv)
1150 gv = autogv;
1151 }
1152 }
1153
1154 return gv;
1155}
1156
1157GV*
1158Perl_gv_autoload_sv(pTHX_ HV *stash, SV* namesv, U32 flags)
1159{
1160 char *namepv;
1161 STRLEN namelen;
1162 PERL_ARGS_ASSERT_GV_AUTOLOAD_SV;
1163 namepv = SvPV(namesv, namelen);
1164 if (SvUTF8(namesv))
1165 flags |= SVf_UTF8;
1166 return gv_autoload_pvn(stash, namepv, namelen, flags);
1167}
1168
1169GV*
1170Perl_gv_autoload_pv(pTHX_ HV *stash, const char *namepv, U32 flags)
1171{
1172 PERL_ARGS_ASSERT_GV_AUTOLOAD_PV;
1173 return gv_autoload_pvn(stash, namepv, strlen(namepv), flags);
1174}
1175
1176GV*
1177Perl_gv_autoload_pvn(pTHX_ HV *stash, const char *name, STRLEN len, U32 flags)
1178{
1179 GV* gv;
1180 CV* cv;
1181 HV* varstash;
1182 GV* vargv;
1183 SV* varsv;
1184 SV *packname = NULL;
1185 U32 is_utf8 = flags & SVf_UTF8 ? SVf_UTF8 : 0;
1186
1187 PERL_ARGS_ASSERT_GV_AUTOLOAD_PVN;
1188
1189 if (len == S_autolen && memEQ(name, S_autoload, S_autolen))
1190 return NULL;
1191 if (stash) {
1192 if (SvTYPE(stash) < SVt_PVHV) {
1193 STRLEN packname_len = 0;
1194 const char * const packname_ptr = SvPV_const(MUTABLE_SV(stash), packname_len);
1195 packname = newSVpvn_flags(packname_ptr, packname_len,
1196 SVs_TEMP | SvUTF8(stash));
1197 stash = NULL;
1198 }
1199 else
1200 packname = sv_2mortal(newSVhek(HvNAME_HEK(stash)));
1201 if (flags & GV_SUPER) sv_catpvs(packname, "::SUPER");
1202 }
1203 if (!(gv = gv_fetchmeth_pvn(stash, S_autoload, S_autolen, FALSE,
1204 is_utf8 | (flags & GV_SUPER))))
1205 return NULL;
1206 cv = GvCV(gv);
1207
1208 if (!(CvROOT(cv) || CvXSUB(cv)))
1209 return NULL;
1210
1211 /*
1212 * Inheriting AUTOLOAD for non-methods works ... for now.
1213 */
1214 if (
1215 !(flags & GV_AUTOLOAD_ISMETHOD)
1216 && (GvCVGEN(gv) || GvSTASH(gv) != stash)
1217 )
1218 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED),
1219 "Use of inherited AUTOLOAD for non-method %" SVf
1220 "::%" UTF8f "() is deprecated. This will be "
1221 "fatal in Perl 5.28",
1222 SVfARG(packname),
1223 UTF8fARG(is_utf8, len, name));
1224
1225 if (CvISXSUB(cv)) {
1226 /* Instead of forcing the XSUB do another lookup for $AUTOLOAD
1227 * and split that value on the last '::', pass along the same data
1228 * via the SvPVX field in the CV, and the stash in CvSTASH.
1229 *
1230 * Due to an unfortunate accident of history, the SvPVX field
1231 * serves two purposes. It is also used for the subroutine's pro-
1232 * type. Since SvPVX has been documented as returning the sub name
1233 * for a long time, but not as returning the prototype, we have
1234 * to preserve the SvPVX AUTOLOAD behaviour and put the prototype
1235 * elsewhere.
1236 *
1237 * We put the prototype in the same allocated buffer, but after
1238 * the sub name. The SvPOK flag indicates the presence of a proto-
1239 * type. The CvAUTOLOAD flag indicates the presence of a sub name.
1240 * If both flags are on, then SvLEN is used to indicate the end of
1241 * the prototype (artificially lower than what is actually allo-
1242 * cated), at the risk of having to reallocate a few bytes unneces-
1243 * sarily--but that should happen very rarely, if ever.
1244 *
1245 * We use SvUTF8 for both prototypes and sub names, so if one is
1246 * UTF8, the other must be upgraded.
1247 */
1248 CvSTASH_set(cv, stash);
1249 if (SvPOK(cv)) { /* Ouch! */
1250 SV * const tmpsv = newSVpvn_flags(name, len, is_utf8);
1251 STRLEN ulen;
1252 const char *proto = CvPROTO(cv);
1253 assert(proto);
1254 if (SvUTF8(cv))
1255 sv_utf8_upgrade_flags_grow(tmpsv, 0, CvPROTOLEN(cv) + 2);
1256 ulen = SvCUR(tmpsv);
1257 SvCUR(tmpsv)++; /* include null in string */
1258 sv_catpvn_flags(
1259 tmpsv, proto, CvPROTOLEN(cv), SV_CATBYTES*!SvUTF8(cv)
1260 );
1261 SvTEMP_on(tmpsv); /* Allow theft */
1262 sv_setsv_nomg((SV *)cv, tmpsv);
1263 SvTEMP_off(tmpsv);
1264 SvREFCNT_dec_NN(tmpsv);
1265 SvLEN(cv) = SvCUR(cv) + 1;
1266 SvCUR(cv) = ulen;
1267 }
1268 else {
1269 sv_setpvn((SV *)cv, name, len);
1270 SvPOK_off(cv);
1271 if (is_utf8)
1272 SvUTF8_on(cv);
1273 else SvUTF8_off(cv);
1274 }
1275 CvAUTOLOAD_on(cv);
1276 }
1277
1278 /*
1279 * Given &FOO::AUTOLOAD, set $FOO::AUTOLOAD to desired function name.
1280 * The subroutine's original name may not be "AUTOLOAD", so we don't
1281 * use that, but for lack of anything better we will use the sub's
1282 * original package to look up $AUTOLOAD.
1283 */
1284 varstash = CvNAMED(cv) ? CvSTASH(cv) : GvSTASH(CvGV(cv));
1285 vargv = *(GV**)hv_fetch(varstash, S_autoload, S_autolen, TRUE);
1286 ENTER;
1287
1288 if (!isGV(vargv)) {
1289 gv_init_pvn(vargv, varstash, S_autoload, S_autolen, 0);
1290#ifdef PERL_DONT_CREATE_GVSV
1291 GvSV(vargv) = newSV(0);
1292#endif
1293 }
1294 LEAVE;
1295 varsv = GvSVn(vargv);
1296 SvTAINTED_off(varsv); /* previous $AUTOLOAD taint is obsolete */
1297 /* XXX: this process is not careful to avoid extra magic gets and sets; tied $AUTOLOAD will get noise */
1298 sv_setsv(varsv, packname);
1299 sv_catpvs(varsv, "::");
1300 /* Ensure SvSETMAGIC() is called if necessary. In particular, to clear
1301 tainting if $FOO::AUTOLOAD was previously tainted, but is not now. */
1302 sv_catpvn_flags(
1303 varsv, name, len,
1304 SV_SMAGIC|(is_utf8 ? SV_CATUTF8 : SV_CATBYTES)
1305 );
1306 if (is_utf8)
1307 SvUTF8_on(varsv);
1308 return gv;
1309}
1310
1311
1312/* require_tie_mod() internal routine for requiring a module
1313 * that implements the logic of automatic ties like %! and %-
1314 * It loads the module and then calls the _tie_it subroutine
1315 * with the passed gv as an argument.
1316 *
1317 * The "gv" parameter should be the glob.
1318 * "varname" holds the 1-char name of the var, used for error messages.
1319 * "namesv" holds the module name. Its refcount will be decremented.
1320 * "flags": if flag & 1 then save the scalar before loading.
1321 * For the protection of $! to work (it is set by this routine)
1322 * the sv slot must already be magicalized.
1323 */
1324STATIC void
1325S_require_tie_mod(pTHX_ GV *gv, const char varname, const char * name,
1326 STRLEN len, const U32 flags)
1327{
1328 const SV * const target = varname == '[' ? GvSV(gv) : (SV *)GvHV(gv);
1329
1330 PERL_ARGS_ASSERT_REQUIRE_TIE_MOD;
1331
1332 /* If it is not tied */
1333 if (!target || !SvRMAGICAL(target)
1334 || !mg_find(target,
1335 varname == '[' ? PERL_MAGIC_tiedscalar : PERL_MAGIC_tied))
1336 {
1337 HV *stash;
1338 GV **gvp;
1339 dSP;
1340
1341 ENTER;
1342
1343#define HV_FETCH_TIE_FUNC (GV **)hv_fetchs(stash, "_tie_it", 0)
1344
1345 /* Load the module if it is not loaded. */
1346 if (!(stash = gv_stashpvn(name, len, 0))
1347 || !(gvp = HV_FETCH_TIE_FUNC) || !*gvp || !GvCV(*gvp))
1348 {
1349 SV * const module = newSVpvn(name, len);
1350 const char type = varname == '[' ? '$' : '%';
1351 if ( flags & 1 )
1352 save_scalar(gv);
1353 Perl_load_module(aTHX_ PERL_LOADMOD_NOIMPORT, module, NULL);
1354 assert(sp == PL_stack_sp);
1355 stash = gv_stashpvn(name, len, 0);
1356 if (!stash)
1357 Perl_croak(aTHX_ "panic: Can't use %c%c because %s is not available",
1358 type, varname, name);
1359 else if (!(gvp = HV_FETCH_TIE_FUNC) || !*gvp || !GvCV(*gvp))
1360 Perl_croak(aTHX_ "panic: Can't use %c%c because %s does not define _tie_it",
1361 type, varname, name);
1362 }
1363 /* Now call the tie function. It should be in *gvp. */
1364 assert(gvp); assert(*gvp); assert(GvCV(*gvp));
1365 PUSHMARK(SP);
1366 XPUSHs((SV *)gv);
1367 PUTBACK;
1368 call_sv((SV *)*gvp, G_VOID|G_DISCARD);
1369 LEAVE;
1370 }
1371}
1372
1373/* add a require_tie_mod_s - the _s suffix is similar to pvs type suffixes,
1374 * IOW it means we do STR_WITH_LEN() ourselves and the user should pass in
1375 * a true string WITHOUT a len.
1376 */
1377#define require_tie_mod_s(gv, varname, name, flags) \
1378 S_require_tie_mod(aTHX_ gv, varname, STR_WITH_LEN(name), flags)
1379
1380/*
1381=for apidoc gv_stashpv
1382
1383Returns a pointer to the stash for a specified package. Uses C<strlen> to
1384determine the length of C<name>, then calls C<gv_stashpvn()>.
1385
1386=cut
1387*/
1388
1389HV*
1390Perl_gv_stashpv(pTHX_ const char *name, I32 create)
1391{
1392 PERL_ARGS_ASSERT_GV_STASHPV;
1393 return gv_stashpvn(name, strlen(name), create);
1394}
1395
1396/*
1397=for apidoc gv_stashpvn
1398
1399Returns a pointer to the stash for a specified package. The C<namelen>
1400parameter indicates the length of the C<name>, in bytes. C<flags> is passed
1401to C<gv_fetchpvn_flags()>, so if set to C<GV_ADD> then the package will be
1402created if it does not already exist. If the package does not exist and
1403C<flags> is 0 (or any other setting that does not create packages) then C<NULL>
1404is returned.
1405
1406Flags may be one of:
1407
1408 GV_ADD
1409 SVf_UTF8
1410 GV_NOADD_NOINIT
1411 GV_NOINIT
1412 GV_NOEXPAND
1413 GV_ADDMG
1414
1415The most important of which are probably C<GV_ADD> and C<SVf_UTF8>.
1416
1417Note, use of C<gv_stashsv> instead of C<gv_stashpvn> where possible is strongly
1418recommended for performance reasons.
1419
1420=cut
1421*/
1422
1423/*
1424gv_stashpvn_internal
1425
1426Perform the internal bits of gv_stashsvpvn_cached. You could think of this
1427as being one half of the logic. Not to be called except from gv_stashsvpvn_cached().
1428
1429*/
1430
1431PERL_STATIC_INLINE HV*
1432S_gv_stashpvn_internal(pTHX_ const char *name, U32 namelen, I32 flags)
1433{
1434 char smallbuf[128];
1435 char *tmpbuf;
1436 HV *stash;
1437 GV *tmpgv;
1438 U32 tmplen = namelen + 2;
1439
1440 PERL_ARGS_ASSERT_GV_STASHPVN_INTERNAL;
1441
1442 if (tmplen <= sizeof smallbuf)
1443 tmpbuf = smallbuf;
1444 else
1445 Newx(tmpbuf, tmplen, char);
1446 Copy(name, tmpbuf, namelen, char);
1447 tmpbuf[namelen] = ':';
1448 tmpbuf[namelen+1] = ':';
1449 tmpgv = gv_fetchpvn_flags(tmpbuf, tmplen, flags, SVt_PVHV);
1450 if (tmpbuf != smallbuf)
1451 Safefree(tmpbuf);
1452 if (!tmpgv || !isGV_with_GP(tmpgv))
1453 return NULL;
1454 stash = GvHV(tmpgv);
1455 if (!(flags & ~GV_NOADD_MASK) && !stash) return NULL;
1456 assert(stash);
1457 if (!HvNAME_get(stash)) {
1458 hv_name_set(stash, name, namelen, flags & SVf_UTF8 ? SVf_UTF8 : 0 );
1459
1460 /* FIXME: This is a repeat of logic in gv_fetchpvn_flags */
1461 /* If the containing stash has multiple effective
1462 names, see that this one gets them, too. */
1463 if (HvAUX(GvSTASH(tmpgv))->xhv_name_count)
1464 mro_package_moved(stash, NULL, tmpgv, 1);
1465 }
1466 return stash;
1467}
1468
1469/*
1470gv_stashsvpvn_cached
1471
1472Returns a pointer to the stash for a specified package, possibly
1473cached. Implements both C<gv_stashpvn> and C<gv_stashsv>.
1474
1475Requires one of either namesv or namepv to be non-null.
1476
1477See C<L</gv_stashpvn>> for details on "flags".
1478
1479Note the sv interface is strongly preferred for performance reasons.
1480
1481*/
1482
1483#define PERL_ARGS_ASSERT_GV_STASHSVPVN_CACHED \
1484 assert(namesv || name)
1485
1486PERL_STATIC_INLINE HV*
1487S_gv_stashsvpvn_cached(pTHX_ SV *namesv, const char *name, U32 namelen, I32 flags)
1488{
1489 HV* stash;
1490 HE* he;
1491
1492 PERL_ARGS_ASSERT_GV_STASHSVPVN_CACHED;
1493
1494 he = (HE *)hv_common(
1495 PL_stashcache, namesv, name, namelen,
1496 (flags & SVf_UTF8) ? HVhek_UTF8 : 0, 0, NULL, 0
1497 );
1498
1499 if (he) {
1500 SV *sv = HeVAL(he);
1501 HV *hv;
1502 assert(SvIOK(sv));
1503 hv = INT2PTR(HV*, SvIVX(sv));
1504 assert(SvTYPE(hv) == SVt_PVHV);
1505 return hv;
1506 }
1507 else if (flags & GV_CACHE_ONLY) return NULL;
1508
1509 if (namesv) {
1510 if (SvOK(namesv)) { /* prevent double uninit warning */
1511 STRLEN len;
1512 name = SvPV_const(namesv, len);
1513 namelen = len;
1514 flags |= SvUTF8(namesv);
1515 } else {
1516 name = ""; namelen = 0;
1517 }
1518 }
1519 stash = gv_stashpvn_internal(name, namelen, flags);
1520
1521 if (stash && namelen) {
1522 SV* const ref = newSViv(PTR2IV(stash));
1523 (void)hv_store(PL_stashcache, name,
1524 (flags & SVf_UTF8) ? -(I32)namelen : (I32)namelen, ref, 0);
1525 }
1526
1527 return stash;
1528}
1529
1530HV*
1531Perl_gv_stashpvn(pTHX_ const char *name, U32 namelen, I32 flags)
1532{
1533 PERL_ARGS_ASSERT_GV_STASHPVN;
1534 return gv_stashsvpvn_cached(NULL, name, namelen, flags);
1535}
1536
1537/*
1538=for apidoc gv_stashsv
1539
1540Returns a pointer to the stash for a specified package. See
1541C<L</gv_stashpvn>>.
1542
1543Note this interface is strongly preferred over C<gv_stashpvn> for performance
1544reasons.
1545
1546=cut
1547*/
1548
1549HV*
1550Perl_gv_stashsv(pTHX_ SV *sv, I32 flags)
1551{
1552 PERL_ARGS_ASSERT_GV_STASHSV;
1553 return gv_stashsvpvn_cached(sv, NULL, 0, flags);
1554}
1555
1556
1557GV *
1558Perl_gv_fetchpv(pTHX_ const char *nambeg, I32 add, const svtype sv_type) {
1559 PERL_ARGS_ASSERT_GV_FETCHPV;
1560 return gv_fetchpvn_flags(nambeg, strlen(nambeg), add, sv_type);
1561}
1562
1563GV *
1564Perl_gv_fetchsv(pTHX_ SV *name, I32 flags, const svtype sv_type) {
1565 STRLEN len;
1566 const char * const nambeg =
1567 SvPV_flags_const(name, len, flags & GV_NO_SVGMAGIC ? 0 : SV_GMAGIC);
1568 PERL_ARGS_ASSERT_GV_FETCHSV;
1569 return gv_fetchpvn_flags(nambeg, len, flags | SvUTF8(name), sv_type);
1570}
1571
1572PERL_STATIC_INLINE void
1573S_gv_magicalize_isa(pTHX_ GV *gv)
1574{
1575 AV* av;
1576
1577 PERL_ARGS_ASSERT_GV_MAGICALIZE_ISA;
1578
1579 av = GvAVn(gv);
1580 GvMULTI_on(gv);
1581 sv_magic(MUTABLE_SV(av), MUTABLE_SV(gv), PERL_MAGIC_isa,
1582 NULL, 0);
1583}
1584
1585/* This function grabs name and tries to split a stash and glob
1586 * from its contents. TODO better description, comments
1587 *
1588 * If the function returns TRUE and 'name == name_end', then
1589 * 'gv' can be directly returned to the caller of gv_fetchpvn_flags
1590 */
1591PERL_STATIC_INLINE bool
1592S_parse_gv_stash_name(pTHX_ HV **stash, GV **gv, const char **name,
1593 STRLEN *len, const char *nambeg, STRLEN full_len,
1594 const U32 is_utf8, const I32 add)
1595{
1596 const char *name_cursor;
1597 const char *const name_end = nambeg + full_len;
1598 const char *const name_em1 = name_end - 1;
1599
1600 PERL_ARGS_ASSERT_PARSE_GV_STASH_NAME;
1601
1602 if ( full_len > 2
1603 && **name == '*'
1604 && isIDFIRST_lazy_if_safe(*name + 1, name_end, is_utf8))
1605 {
1606 /* accidental stringify on a GV? */
1607 (*name)++;
1608 }
1609
1610 for (name_cursor = *name; name_cursor < name_end; name_cursor++) {
1611 if (name_cursor < name_em1 &&
1612 ((*name_cursor == ':' && name_cursor[1] == ':')
1613 || *name_cursor == '\''))
1614 {
1615 if (!*stash)
1616 *stash = PL_defstash;
1617 if (!*stash || !SvREFCNT(*stash)) /* symbol table under destruction */
1618 return FALSE;
1619
1620 *len = name_cursor - *name;
1621 if (name_cursor > nambeg) { /* Skip for initial :: or ' */
1622 const char *key;
1623 GV**gvp;
1624 if (*name_cursor == ':') {
1625 key = *name;
1626 *len += 2;
1627 }
1628 else {
1629 char *tmpbuf;
1630 Newx(tmpbuf, *len+2, char);
1631 Copy(*name, tmpbuf, *len, char);
1632 tmpbuf[(*len)++] = ':';
1633 tmpbuf[(*len)++] = ':';
1634 key = tmpbuf;
1635 }
1636 gvp = (GV**)hv_fetch(*stash, key, is_utf8 ? -((I32)*len) : (I32)*len, add);
1637 *gv = gvp ? *gvp : NULL;
1638 if (*gv && *gv != (const GV *)&PL_sv_undef) {
1639 if (SvTYPE(*gv) != SVt_PVGV)
1640 gv_init_pvn(*gv, *stash, key, *len, (add & GV_ADDMULTI)|is_utf8);
1641 else
1642 GvMULTI_on(*gv);
1643 }
1644 if (key != *name)
1645 Safefree(key);
1646 if (!*gv || *gv == (const GV *)&PL_sv_undef)
1647 return FALSE;
1648
1649 if (!(*stash = GvHV(*gv))) {
1650 *stash = GvHV(*gv) = newHV();
1651 if (!HvNAME_get(*stash)) {
1652 if (GvSTASH(*gv) == PL_defstash && *len == 6
1653 && strEQs(*name, "CORE"))
1654 hv_name_sets(*stash, "CORE", 0);
1655 else
1656 hv_name_set(
1657 *stash, nambeg, name_cursor-nambeg, is_utf8
1658 );
1659 /* If the containing stash has multiple effective
1660 names, see that this one gets them, too. */
1661 if (HvAUX(GvSTASH(*gv))->xhv_name_count)
1662 mro_package_moved(*stash, NULL, *gv, 1);
1663 }
1664 }
1665 else if (!HvNAME_get(*stash))
1666 hv_name_set(*stash, nambeg, name_cursor - nambeg, is_utf8);
1667 }
1668
1669 if (*name_cursor == ':')
1670 name_cursor++;
1671 *name = name_cursor+1;
1672 if (*name == name_end) {
1673 if (!*gv) {
1674 *gv = MUTABLE_GV(*hv_fetchs(PL_defstash, "main::", TRUE));
1675 if (SvTYPE(*gv) != SVt_PVGV) {
1676 gv_init_pvn(*gv, PL_defstash, "main::", 6,
1677 GV_ADDMULTI);
1678 GvHV(*gv) =
1679 MUTABLE_HV(SvREFCNT_inc_simple(PL_defstash));
1680 }
1681 }
1682 return TRUE;
1683 }
1684 }
1685 }
1686 *len = name_cursor - *name;
1687 return TRUE;
1688}
1689
1690/* Checks if an unqualified name is in the main stash */
1691PERL_STATIC_INLINE bool
1692S_gv_is_in_main(pTHX_ const char *name, STRLEN len, const U32 is_utf8)
1693{
1694 PERL_ARGS_ASSERT_GV_IS_IN_MAIN;
1695
1696 /* If it's an alphanumeric variable */
1697 if ( len && isIDFIRST_lazy_if_safe(name, name + len, is_utf8) ) {
1698 /* Some "normal" variables are always in main::,
1699 * like INC or STDOUT.
1700 */
1701 switch (len) {
1702 case 1:
1703 if (*name == '_')
1704 return TRUE;
1705 break;
1706 case 3:
1707 if ((name[0] == 'I' && name[1] == 'N' && name[2] == 'C')
1708 || (name[0] == 'E' && name[1] == 'N' && name[2] == 'V')
1709 || (name[0] == 'S' && name[1] == 'I' && name[2] == 'G'))
1710 return TRUE;
1711 break;
1712 case 4:
1713 if (name[0] == 'A' && name[1] == 'R' && name[2] == 'G'
1714 && name[3] == 'V')
1715 return TRUE;
1716 break;
1717 case 5:
1718 if (name[0] == 'S' && name[1] == 'T' && name[2] == 'D'
1719 && name[3] == 'I' && name[4] == 'N')
1720 return TRUE;
1721 break;
1722 case 6:
1723 if ((name[0] == 'S' && name[1] == 'T' && name[2] == 'D')
1724 &&((name[3] == 'O' && name[4] == 'U' && name[5] == 'T')
1725 ||(name[3] == 'E' && name[4] == 'R' && name[5] == 'R')))
1726 return TRUE;
1727 break;
1728 case 7:
1729 if (name[0] == 'A' && name[1] == 'R' && name[2] == 'G'
1730 && name[3] == 'V' && name[4] == 'O' && name[5] == 'U'
1731 && name[6] == 'T')
1732 return TRUE;
1733 break;
1734 }
1735 }
1736 /* *{""}, or a special variable like $@ */
1737 else
1738 return TRUE;
1739
1740 return FALSE;
1741}
1742
1743
1744/* This function is called if parse_gv_stash_name() failed to
1745 * find a stash, or if GV_NOTQUAL or an empty name was passed
1746 * to gv_fetchpvn_flags.
1747 *
1748 * It returns FALSE if the default stash can't be found nor created,
1749 * which might happen during global destruction.
1750 */
1751PERL_STATIC_INLINE bool
1752S_find_default_stash(pTHX_ HV **stash, const char *name, STRLEN len,
1753 const U32 is_utf8, const I32 add,
1754 const svtype sv_type)
1755{
1756 PERL_ARGS_ASSERT_FIND_DEFAULT_STASH;
1757
1758 /* No stash in name, so see how we can default */
1759
1760 if ( gv_is_in_main(name, len, is_utf8) ) {
1761 *stash = PL_defstash;
1762 }
1763 else {
1764 if (IN_PERL_COMPILETIME) {
1765 *stash = PL_curstash;
1766 if (add && (PL_hints & HINT_STRICT_VARS) &&
1767 sv_type != SVt_PVCV &&
1768 sv_type != SVt_PVGV &&
1769 sv_type != SVt_PVFM &&
1770 sv_type != SVt_PVIO &&
1771 !(len == 1 && sv_type == SVt_PV &&
1772 (*name == 'a' || *name == 'b')) )
1773 {
1774 GV**gvp = (GV**)hv_fetch(*stash,name,is_utf8 ? -(I32)len : (I32)len,0);
1775 if (!gvp || *gvp == (const GV *)&PL_sv_undef ||
1776 SvTYPE(*gvp) != SVt_PVGV)
1777 {
1778 *stash = NULL;
1779 }
1780 else if ((sv_type == SVt_PV && !GvIMPORTED_SV(*gvp)) ||
1781 (sv_type == SVt_PVAV && !GvIMPORTED_AV(*gvp)) ||
1782 (sv_type == SVt_PVHV && !GvIMPORTED_HV(*gvp)) )
1783 {
1784 /* diag_listed_as: Variable "%s" is not imported%s */
1785 Perl_ck_warner_d(
1786 aTHX_ packWARN(WARN_MISC),
1787 "Variable \"%c%" UTF8f "\" is not imported",
1788 sv_type == SVt_PVAV ? '@' :
1789 sv_type == SVt_PVHV ? '%' : '$',
1790 UTF8fARG(is_utf8, len, name));
1791 if (GvCVu(*gvp))
1792 Perl_ck_warner_d(
1793 aTHX_ packWARN(WARN_MISC),
1794 "\t(Did you mean &%" UTF8f " instead?)\n",
1795 UTF8fARG(is_utf8, len, name)
1796 );
1797 *stash = NULL;
1798 }
1799 }
1800 }
1801 else {
1802 /* Use the current op's stash */
1803 *stash = CopSTASH(PL_curcop);
1804 }
1805 }
1806
1807 if (!*stash) {
1808 if (add && !PL_in_clean_all) {
1809 GV *gv;
1810 qerror(Perl_mess(aTHX_
1811 "Global symbol \"%s%" UTF8f
1812 "\" requires explicit package name (did you forget to "
1813 "declare \"my %s%" UTF8f "\"?)",
1814 (sv_type == SVt_PV ? "$"
1815 : sv_type == SVt_PVAV ? "@"
1816 : sv_type == SVt_PVHV ? "%"
1817 : ""), UTF8fARG(is_utf8, len, name),
1818 (sv_type == SVt_PV ? "$"
1819 : sv_type == SVt_PVAV ? "@"
1820 : sv_type == SVt_PVHV ? "%"
1821 : ""), UTF8fARG(is_utf8, len, name)));
1822 /* To maintain the output of errors after the strict exception
1823 * above, and to keep compat with older releases, rather than
1824 * placing the variables in the pad, we place
1825 * them in the <none>:: stash.
1826 */
1827 gv = gv_fetchpvs("<none>::", GV_ADDMULTI, SVt_PVHV);
1828 if (!gv) {
1829 /* symbol table under destruction */
1830 return FALSE;
1831 }
1832 *stash = GvHV(gv);
1833 }
1834 else
1835 return FALSE;
1836 }
1837
1838 if (!SvREFCNT(*stash)) /* symbol table under destruction */
1839 return FALSE;
1840
1841 return TRUE;
1842}
1843
1844/* gv_magicalize only turns on the SVf_READONLY flag, not SVf_PROTECT. So
1845 redefine SvREADONLY_on for that purpose. We don’t use it later on in
1846 this file. */
1847#undef SvREADONLY_on
1848#define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
1849
1850/* gv_magicalize() is called by gv_fetchpvn_flags when creating
1851 * a new GV.
1852 * Note that it does not insert the GV into the stash prior to
1853 * magicalization, which some variables require need in order
1854 * to work (like $[, %+, %-, %!), so callers must take care of
1855 * that.
1856 *
1857 * It returns true if the gv did turn out to be magical one; i.e.,
1858 * if gv_magicalize actually did something.
1859 */
1860PERL_STATIC_INLINE bool
1861S_gv_magicalize(pTHX_ GV *gv, HV *stash, const char *name, STRLEN len,
1862 const svtype sv_type)
1863{
1864 SSize_t paren;
1865
1866 PERL_ARGS_ASSERT_GV_MAGICALIZE;
1867
1868 if (stash != PL_defstash) { /* not the main stash */
1869 /* We only have to check for a few names here: a, b, EXPORT, ISA
1870 and VERSION. All the others apply only to the main stash or to
1871 CORE (which is checked right after this). */
1872 if (len) {
1873 switch (*name) {
1874 case 'E':
1875 if (
1876 len >= 6 && name[1] == 'X' &&
1877 (memEQs(name, len, "EXPORT")
1878 ||memEQs(name, len, "EXPORT_OK")
1879 ||memEQs(name, len, "EXPORT_FAIL")
1880 ||memEQs(name, len, "EXPORT_TAGS"))
1881 )
1882 GvMULTI_on(gv);
1883 break;
1884 case 'I':
1885 if (memEQs(name, len, "ISA"))
1886 gv_magicalize_isa(gv);
1887 break;
1888 case 'V':
1889 if (memEQs(name, len, "VERSION"))
1890 GvMULTI_on(gv);
1891 break;
1892 case 'a':
1893 if (stash == PL_debstash && memEQs(name, len, "args")) {
1894 GvMULTI_on(gv_AVadd(gv));
1895 break;
1896 }
1897 /* FALLTHROUGH */
1898 case 'b':
1899 if (len == 1 && sv_type == SVt_PV)
1900 GvMULTI_on(gv);
1901 /* FALLTHROUGH */
1902 default:
1903 goto try_core;
1904 }
1905 goto ret;
1906 }
1907 try_core:
1908 if (len > 1 /* shortest is uc */ && HvNAMELEN_get(stash) == 4) {
1909 /* Avoid null warning: */
1910 const char * const stashname = HvNAME(stash); assert(stashname);
1911 if (strEQs(stashname, "CORE"))
1912 S_maybe_add_coresub(aTHX_ 0, gv, name, len);
1913 }
1914 }
1915 else if (len > 1) {
1916#ifndef EBCDIC
1917 if (*name > 'V' ) {
1918 NOOP;
1919 /* Nothing else to do.
1920 The compiler will probably turn the switch statement into a
1921 branch table. Make sure we avoid even that small overhead for
1922 the common case of lower case variable names. (On EBCDIC
1923 platforms, we can't just do:
1924 if (NATIVE_TO_ASCII(*name) > NATIVE_TO_ASCII('V') ) {
1925 because cases like '\027' in the switch statement below are
1926 C1 (non-ASCII) controls on those platforms, so the remapping
1927 would make them larger than 'V')
1928 */
1929 } else
1930#endif
1931 {
1932 switch (*name) {
1933 case 'A':
1934 if (memEQs(name, len, "ARGV")) {
1935 IoFLAGS(GvIOn(gv)) |= IOf_ARGV|IOf_START;
1936 }
1937 else if (memEQs(name, len, "ARGVOUT")) {
1938 GvMULTI_on(gv);
1939 }
1940 break;
1941 case 'E':
1942 if (
1943 len >= 6 && name[1] == 'X' &&
1944 (memEQs(name, len, "EXPORT")
1945 ||memEQs(name, len, "EXPORT_OK")
1946 ||memEQs(name, len, "EXPORT_FAIL")
1947 ||memEQs(name, len, "EXPORT_TAGS"))
1948 )
1949 GvMULTI_on(gv);
1950 break;
1951 case 'I':
1952 if (memEQs(name, len, "ISA")) {
1953 gv_magicalize_isa(gv);
1954 }
1955 break;
1956 case 'S':
1957 if (memEQs(name, len, "SIG")) {
1958 HV *hv;
1959 I32 i;
1960 if (!PL_psig_name) {
1961 Newxz(PL_psig_name, 2 * SIG_SIZE, SV*);
1962 Newxz(PL_psig_pend, SIG_SIZE, int);
1963 PL_psig_ptr = PL_psig_name + SIG_SIZE;
1964 } else {
1965 /* I think that the only way to get here is to re-use an
1966 embedded perl interpreter, where the previous
1967 use didn't clean up fully because
1968 PL_perl_destruct_level was 0. I'm not sure that we
1969 "support" that, in that I suspect in that scenario
1970 there are sufficient other garbage values left in the
1971 interpreter structure that something else will crash
1972 before we get here. I suspect that this is one of
1973 those "doctor, it hurts when I do this" bugs. */
1974 Zero(PL_psig_name, 2 * SIG_SIZE, SV*);
1975 Zero(PL_psig_pend, SIG_SIZE, int);
1976 }
1977 GvMULTI_on(gv);
1978 hv = GvHVn(gv);
1979 hv_magic(hv, NULL, PERL_MAGIC_sig);
1980 for (i = 1; i < SIG_SIZE; i++) {
1981 SV * const * const init = hv_fetch(hv, PL_sig_name[i], strlen(PL_sig_name[i]), 1);
1982 if (init)
1983 sv_setsv(*init, &PL_sv_undef);
1984 }
1985 }
1986 break;
1987 case 'V':
1988 if (memEQs(name, len, "VERSION"))
1989 GvMULTI_on(gv);
1990 break;
1991 case '\003': /* $^CHILD_ERROR_NATIVE */
1992 if (memEQs(name, len, "\003HILD_ERROR_NATIVE"))
1993 goto magicalize;
1994 /* @{^CAPTURE} %{^CAPTURE} */
1995 if (memEQs(name, len, "\003APTURE")) {
1996 AV* const av = GvAVn(gv);
1997 UV uv= *name;
1998
1999 sv_magic(MUTABLE_SV(av), (SV*)uv, PERL_MAGIC_regdata, NULL, 0);
2000 SvREADONLY_on(av);
2001
2002 if (sv_type == SVt_PVHV || sv_type == SVt_PVGV)
2003 require_tie_mod_s(gv, '-', "Tie::Hash::NamedCapture",0);
2004
2005 } else /* %{^CAPTURE_ALL} */
2006 if (memEQs(name, len, "\003APTURE_ALL")) {
2007 if (sv_type == SVt_PVHV || sv_type == SVt_PVGV)
2008 require_tie_mod_s(gv, '+', "Tie::Hash::NamedCapture",0);
2009 }
2010 break;
2011 case '\005': /* $^ENCODING */
2012 if (memEQs(name, len, "\005NCODING"))
2013 goto magicalize;
2014 break;
2015 case '\007': /* $^GLOBAL_PHASE */
2016 if (memEQs(name, len, "\007LOBAL_PHASE"))
2017 goto ro_magicalize;
2018 break;
2019 case '\014': /* $^LAST_FH */
2020 if (memEQs(name, len, "\014AST_FH"))
2021 goto ro_magicalize;
2022 break;
2023 case '\015': /* $^MATCH */
2024 if (memEQs(name, len, "\015ATCH")) {
2025 paren = RX_BUFF_IDX_CARET_FULLMATCH;
2026 goto storeparen;
2027 }
2028 break;
2029 case '\017': /* $^OPEN */
2030 if (memEQs(name, len, "\017PEN"))
2031 goto magicalize;
2032 break;
2033 case '\020': /* $^PREMATCH $^POSTMATCH */
2034 if (memEQs(name, len, "\020REMATCH")) {
2035 paren = RX_BUFF_IDX_CARET_PREMATCH;
2036 goto storeparen;
2037 }
2038 if (memEQs(name, len, "\020OSTMATCH")) {
2039 paren = RX_BUFF_IDX_CARET_POSTMATCH;
2040 goto storeparen;
2041 }
2042 break;
2043 case '\024': /* ${^TAINT} */
2044 if (memEQs(name, len, "\024AINT"))
2045 goto ro_magicalize;
2046 break;
2047 case '\025': /* ${^UNICODE}, ${^UTF8LOCALE} */
2048 if (memEQs(name, len, "\025NICODE"))
2049 goto ro_magicalize;
2050 if (memEQs(name, len, "\025TF8LOCALE"))
2051 goto ro_magicalize;
2052 if (memEQs(name, len, "\025TF8CACHE"))
2053 goto magicalize;
2054 break;
2055 case '\027': /* $^WARNING_BITS */
2056 if (memEQs(name, len, "\027ARNING_BITS"))
2057 goto magicalize;
2058#ifdef WIN32
2059 else if (memEQs(name, len, "\027IN32_SLOPPY_STAT"))
2060 goto magicalize;
2061#endif
2062 break;
2063 case '1':
2064 case '2':
2065 case '3':
2066 case '4':
2067 case '5':
2068 case '6':
2069 case '7':
2070 case '8':
2071 case '9':
2072 {
2073 /* Ensures that we have an all-digit variable, ${"1foo"} fails
2074 this test */
2075 UV uv;
2076 if (!grok_atoUV(name, &uv, NULL) || uv > I32_MAX)
2077 goto ret;
2078 /* XXX why are we using a SSize_t? */
2079 paren = (SSize_t)(I32)uv;
2080 goto storeparen;
2081 }
2082 }
2083 }
2084 } else {
2085 /* Names of length 1. (Or 0. But name is NUL terminated, so that will
2086 be case '\0' in this switch statement (ie a default case) */
2087 switch (*name) {
2088 case '&': /* $& */
2089 paren = RX_BUFF_IDX_FULLMATCH;
2090 goto sawampersand;
2091 case '`': /* $` */
2092 paren = RX_BUFF_IDX_PREMATCH;
2093 goto sawampersand;
2094 case '\'': /* $' */
2095 paren = RX_BUFF_IDX_POSTMATCH;
2096 sawampersand:
2097#ifdef PERL_SAWAMPERSAND
2098 if (!(
2099 sv_type == SVt_PVAV ||
2100 sv_type == SVt_PVHV ||
2101 sv_type == SVt_PVCV ||
2102 sv_type == SVt_PVFM ||
2103 sv_type == SVt_PVIO
2104 )) { PL_sawampersand |=
2105 (*name == '`')
2106 ? SAWAMPERSAND_LEFT
2107 : (*name == '&')
2108 ? SAWAMPERSAND_MIDDLE
2109 : SAWAMPERSAND_RIGHT;
2110 }
2111#endif
2112 goto storeparen;
2113 case '1': /* $1 */
2114 case '2': /* $2 */
2115 case '3': /* $3 */
2116 case '4': /* $4 */
2117 case '5': /* $5 */
2118 case '6': /* $6 */
2119 case '7': /* $7 */
2120 case '8': /* $8 */
2121 case '9': /* $9 */
2122 paren = *name - '0';
2123
2124 storeparen:
2125 /* Flag the capture variables with a NULL mg_ptr
2126 Use mg_len for the array index to lookup. */
2127 sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, NULL, paren);
2128 break;
2129
2130 case ':': /* $: */
2131 sv_setpv(GvSVn(gv),PL_chopset);
2132 goto magicalize;
2133
2134 case '?': /* $? */
2135#ifdef COMPLEX_STATUS
2136 SvUPGRADE(GvSVn(gv), SVt_PVLV);
2137#endif
2138 goto magicalize;
2139
2140 case '!': /* $! */
2141 GvMULTI_on(gv);
2142 /* If %! has been used, automatically load Errno.pm. */
2143
2144 sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
2145
2146 /* magicalization must be done before require_tie_mod_s is called */
2147 if (sv_type == SVt_PVHV || sv_type == SVt_PVGV)
2148 require_tie_mod_s(gv, '!', "Errno", 1);
2149
2150 break;
2151 case '-': /* $-, %-, @- */
2152 case '+': /* $+, %+, @+ */
2153 GvMULTI_on(gv); /* no used once warnings here */
2154 { /* $- $+ */
2155 sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
2156 if (*name == '+')
2157 SvREADONLY_on(GvSVn(gv));
2158 }
2159 { /* %- %+ */
2160 if (sv_type == SVt_PVHV || sv_type == SVt_PVGV)
2161 require_tie_mod_s(gv, *name, "Tie::Hash::NamedCapture",0);
2162 }
2163 { /* @- @+ */
2164 AV* const av = GvAVn(gv);
2165 const UV uv = (UV)*name;
2166
2167 sv_magic(MUTABLE_SV(av), (SV*)uv, PERL_MAGIC_regdata, NULL, 0);
2168 SvREADONLY_on(av);
2169 }
2170 break;
2171 case '*': /* $* */
2172 case '#': /* $# */
2173 if (sv_type == SVt_PV)
2174 /* diag_listed_as: $* is no longer supported. Its use will be fatal in Perl 5.30 */
2175 Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_SYNTAX),
2176 "$%c is no longer supported. Its use "
2177 "will be fatal in Perl 5.30", *name);
2178 break;
2179 case '\010': /* $^H */
2180 {
2181 HV *const hv = GvHVn(gv);
2182 hv_magic(hv, NULL, PERL_MAGIC_hints);
2183 }
2184 goto magicalize;
2185 case '[': /* $[ */
2186 if ((sv_type == SVt_PV || sv_type == SVt_PVGV)
2187 && FEATURE_ARYBASE_IS_ENABLED) {
2188 require_tie_mod_s(gv,'[',"arybase",0);
2189 }
2190 else goto magicalize;
2191 break;
2192 case '\023': /* $^S */
2193 ro_magicalize:
2194 SvREADONLY_on(GvSVn(gv));
2195 /* FALLTHROUGH */
2196 case '0': /* $0 */
2197 case '^': /* $^ */
2198 case '~': /* $~ */
2199 case '=': /* $= */
2200 case '%': /* $% */
2201 case '.': /* $. */
2202 case '(': /* $( */
2203 case ')': /* $) */
2204 case '<': /* $< */
2205 case '>': /* $> */
2206 case '\\': /* $\ */
2207 case '/': /* $/ */
2208 case '|': /* $| */
2209 case '$': /* $$ */
2210 case '\001': /* $^A */
2211 case '\003': /* $^C */
2212 case '\004': /* $^D */
2213 case '\005': /* $^E */
2214 case '\006': /* $^F */
2215 case '\011': /* $^I, NOT \t in EBCDIC */
2216 case '\016': /* $^N */
2217 case '\017': /* $^O */
2218 case '\020': /* $^P */
2219 case '\024': /* $^T */
2220 case '\027': /* $^W */
2221 magicalize:
2222 sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
2223 break;
2224
2225 case '\014': /* $^L */
2226 sv_setpvs(GvSVn(gv),"\f");
2227 break;
2228 case ';': /* $; */
2229 sv_setpvs(GvSVn(gv),"\034");
2230 break;
2231 case ']': /* $] */
2232 {
2233 SV * const sv = GvSV(gv);
2234 if (!sv_derived_from(PL_patchlevel, "version"))
2235 upg_version(PL_patchlevel, TRUE);
2236 GvSV(gv) = vnumify(PL_patchlevel);
2237 SvREADONLY_on(GvSV(gv));
2238 SvREFCNT_dec(sv);
2239 }
2240 break;
2241 case '\026': /* $^V */
2242 {
2243 SV * const sv = GvSV(gv);
2244 GvSV(gv) = new_version(PL_patchlevel);
2245 SvREADONLY_on(GvSV(gv));
2246 SvREFCNT_dec(sv);
2247 }
2248 break;
2249 case 'a':
2250 case 'b':
2251 if (sv_type == SVt_PV)
2252 GvMULTI_on(gv);
2253 }
2254 }
2255
2256 ret:
2257 /* Return true if we actually did something. */
2258 return GvAV(gv) || GvHV(gv) || GvIO(gv) || GvCV(gv)
2259 || ( GvSV(gv) && (
2260 SvOK(GvSV(gv)) || SvMAGICAL(GvSV(gv))
2261 )
2262 );
2263}
2264
2265/* If we do ever start using this later on in the file, we need to make
2266 sure we don’t accidentally use the wrong definition. */
2267#undef SvREADONLY_on
2268
2269/* This function is called when the stash already holds the GV of the magic
2270 * variable we're looking for, but we need to check that it has the correct
2271 * kind of magic. For example, if someone first uses $! and then %!, the
2272 * latter would end up here, and we add the Errno tie to the HASH slot of
2273 * the *! glob.
2274 */
2275PERL_STATIC_INLINE void
2276S_maybe_multimagic_gv(pTHX_ GV *gv, const char *name, const svtype sv_type)
2277{
2278 PERL_ARGS_ASSERT_MAYBE_MULTIMAGIC_GV;
2279
2280 if (sv_type == SVt_PVHV || sv_type == SVt_PVGV) {
2281 if (*name == '!')
2282 require_tie_mod_s(gv, '!', "Errno", 1);
2283 else if (*name == '-' || *name == '+')
2284 require_tie_mod_s(gv, *name, "Tie::Hash::NamedCapture", 0);
2285 } else if (sv_type == SVt_PV) {
2286 if (*name == '*' || *name == '#') {
2287 /* diag_listed_as: $# is no longer supported. Its use will be fatal in Perl 5.30 */
2288 Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED,
2289 WARN_SYNTAX),
2290 "$%c is no longer supported. Its use "
2291 "will be fatal in Perl 5.30", *name);
2292 }
2293 }
2294 if (sv_type==SVt_PV || sv_type==SVt_PVGV) {
2295 switch (*name) {
2296 case '[':
2297 require_tie_mod_s(gv,'[',"arybase",0);
2298 break;
2299#ifdef PERL_SAWAMPERSAND
2300 case '`':
2301 PL_sawampersand |= SAWAMPERSAND_LEFT;
2302 (void)GvSVn(gv);
2303 break;
2304 case '&':
2305 PL_sawampersand |= SAWAMPERSAND_MIDDLE;
2306 (void)GvSVn(gv);
2307 break;
2308 case '\'':
2309 PL_sawampersand |= SAWAMPERSAND_RIGHT;
2310 (void)GvSVn(gv);
2311 break;
2312#endif
2313 }
2314 }
2315}
2316
2317GV *
2318Perl_gv_fetchpvn_flags(pTHX_ const char *nambeg, STRLEN full_len, I32 flags,
2319 const svtype sv_type)
2320{
2321 const char *name = nambeg;
2322 GV *gv = NULL;
2323 GV**gvp;
2324 STRLEN len;
2325 HV *stash = NULL;
2326 const I32 no_init = flags & (GV_NOADD_NOINIT | GV_NOINIT);
2327 const I32 no_expand = flags & GV_NOEXPAND;
2328 const I32 add = flags & ~GV_NOADD_MASK;
2329 const U32 is_utf8 = flags & SVf_UTF8;
2330 bool addmg = cBOOL(flags & GV_ADDMG);
2331 const char *const name_end = nambeg + full_len;
2332 U32 faking_it;
2333
2334 PERL_ARGS_ASSERT_GV_FETCHPVN_FLAGS;
2335
2336 /* If we have GV_NOTQUAL, the caller promised that
2337 * there is no stash, so we can skip the check.
2338 * Similarly if full_len is 0, since then we're
2339 * dealing with something like *{""} or ""->foo()
2340 */
2341 if ((flags & GV_NOTQUAL) || !full_len) {
2342 len = full_len;
2343 }
2344 else if (parse_gv_stash_name(&stash, &gv, &name, &len, nambeg, full_len, is_utf8, add)) {
2345 if (name == name_end) return gv;
2346 }
2347 else {
2348 return NULL;
2349 }
2350
2351 if (!stash && !find_default_stash(&stash, name, len, is_utf8, add, sv_type)) {
2352 return NULL;
2353 }
2354
2355 /* By this point we should have a stash and a name */
2356 gvp = (GV**)hv_fetch(stash,name,is_utf8 ? -(I32)len : (I32)len,add);
2357 if (!gvp || *gvp == (const GV *)&PL_sv_undef) {
2358 if (addmg) gv = (GV *)newSV(0);
2359 else return NULL;
2360 }
2361 else gv = *gvp, addmg = 0;
2362 /* From this point on, addmg means gv has not been inserted in the
2363 symtab yet. */
2364
2365 if (SvTYPE(gv) == SVt_PVGV) {
2366 /* The GV already exists, so return it, but check if we need to do
2367 * anything else with it before that.
2368 */
2369 if (add) {
2370 /* This is the heuristic that handles if a variable triggers the
2371 * 'used only once' warning. If there's already a GV in the stash
2372 * with this name, then we assume that the variable has been used
2373 * before and turn its MULTI flag on.
2374 * It's a heuristic because it can easily be "tricked", like with
2375 * BEGIN { $a = 1; $::{foo} = *a }; () = $foo
2376 * not warning about $main::foo being used just once
2377 */
2378 GvMULTI_on(gv);
2379 gv_init_svtype(gv, sv_type);
2380 /* You reach this path once the typeglob has already been created,
2381 either by the same or a different sigil. If this path didn't
2382 exist, then (say) referencing $! first, and %! second would
2383 mean that %! was not handled correctly. */
2384 if (len == 1 && stash == PL_defstash) {
2385 maybe_multimagic_gv(gv, name, sv_type);
2386 }
2387 else if (len == 3 && sv_type == SVt_PVAV
2388 && strEQs(name, "ISA")
2389 && (!GvAV(gv) || !SvSMAGICAL(GvAV(gv))))
2390 gv_magicalize_isa(gv);
2391 }
2392 return gv;
2393 } else if (no_init) {
2394 assert(!addmg);
2395 return gv;
2396 }
2397 /* If GV_NOEXPAND is true and what we got off the stash is a ref,
2398 * don't expand it to a glob. This is an optimization so that things
2399 * copying constants over, like Exporter, don't have to be rewritten
2400 * to take into account that you can store more than just globs in
2401 * stashes.
2402 */
2403 else if (no_expand && SvROK(gv)) {
2404 assert(!addmg);
2405 return gv;
2406 }
2407
2408 /* Adding a new symbol.
2409 Unless of course there was already something non-GV here, in which case
2410 we want to behave as if there was always a GV here, containing some sort
2411 of subroutine.
2412 Otherwise we run the risk of creating things like GvIO, which can cause
2413 subtle bugs. eg the one that tripped up SQL::Translator */
2414
2415 faking_it = SvOK(gv);
2416
2417 if (add & GV_ADDWARN)
2418 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
2419 "Had to create %" UTF8f " unexpectedly",
2420 UTF8fARG(is_utf8, name_end-nambeg, nambeg));
2421 gv_init_pvn(gv, stash, name, len, (add & GV_ADDMULTI)|is_utf8);
2422
2423 if ( full_len != 0
2424 && isIDFIRST_lazy_if_safe(name, name + full_len, is_utf8)
2425 && !ckWARN(WARN_ONCE) )
2426 {
2427 GvMULTI_on(gv) ;
2428 }
2429
2430 /* set up magic where warranted */
2431 if ( gv_magicalize(gv, stash, name, len, sv_type) ) {
2432 /* See 23496c6 */
2433 if (addmg) {
2434 /* gv_magicalize magicalised this gv, so we want it
2435 * stored in the symtab.
2436 * Effectively the caller is asking, ‘Does this gv exist?’
2437 * And we respond, ‘Er, *now* it does!’
2438 */
2439 (void)hv_store(stash,name,len,(SV *)gv,0);
2440 }
2441 }
2442 else if (addmg) {
2443 /* The temporary GV created above */
2444 SvREFCNT_dec_NN(gv);
2445 gv = NULL;
2446 }
2447
2448 if (gv) gv_init_svtype(gv, faking_it ? SVt_PVCV : sv_type);
2449 return gv;
2450}
2451
2452void
2453Perl_gv_fullname4(pTHX_ SV *sv, const GV *gv, const char *prefix, bool keepmain)
2454{
2455 const char *name;
2456 const HV * const hv = GvSTASH(gv);
2457
2458 PERL_ARGS_ASSERT_GV_FULLNAME4;
2459
2460 sv_setpv(sv, prefix ? prefix : "");
2461
2462 if (hv && (name = HvNAME(hv))) {
2463 const STRLEN len = HvNAMELEN(hv);
2464 if (keepmain || strnNE(name, "main", len)) {
2465 sv_catpvn_flags(sv,name,len,HvNAMEUTF8(hv)?SV_CATUTF8:SV_CATBYTES);
2466 sv_catpvs(sv,"::");
2467 }
2468 }
2469 else sv_catpvs(sv,"__ANON__::");
2470 sv_catsv(sv,sv_2mortal(newSVhek(GvNAME_HEK(gv))));
2471}
2472
2473void
2474Perl_gv_efullname4(pTHX_ SV *sv, const GV *gv, const char *prefix, bool keepmain)
2475{
2476 const GV * const egv = GvEGVx(gv);
2477
2478 PERL_ARGS_ASSERT_GV_EFULLNAME4;
2479
2480 gv_fullname4(sv, egv ? egv : gv, prefix, keepmain);
2481}
2482
2483
2484/* recursively scan a stash and any nested stashes looking for entries
2485 * that need the "only used once" warning raised
2486 */
2487
2488void
2489Perl_gv_check(pTHX_ HV *stash)
2490{
2491 I32 i;
2492
2493 PERL_ARGS_ASSERT_GV_CHECK;
2494
2495 if (!SvOOK(stash))
2496 return;
2497
2498 assert(HvARRAY(stash));
2499
2500 for (i = 0; i <= (I32) HvMAX(stash); i++) {
2501 const HE *entry;
2502 /* mark stash is being scanned, to avoid recursing */
2503 HvAUX(stash)->xhv_aux_flags |= HvAUXf_SCAN_STASH;
2504 for (entry = HvARRAY(stash)[i]; entry; entry = HeNEXT(entry)) {
2505 GV *gv;
2506 HV *hv;
2507 STRLEN keylen = HeKLEN(entry);
2508 const char * const key = HeKEY(entry);
2509
2510 if (keylen >= 2 && key[keylen-2] == ':' && key[keylen-1] == ':' &&
2511 (gv = MUTABLE_GV(HeVAL(entry))) && isGV(gv) && (hv = GvHV(gv)))
2512 {
2513 if (hv != PL_defstash && hv != stash
2514 && !(SvOOK(hv)
2515 && (HvAUX(hv)->xhv_aux_flags & HvAUXf_SCAN_STASH))
2516 )
2517 gv_check(hv); /* nested package */
2518 }
2519 else if ( HeKLEN(entry) != 0
2520 && *HeKEY(entry) != '_'
2521 && isIDFIRST_lazy_if_safe(HeKEY(entry),
2522 HeKEY(entry) + HeKLEN(entry),
2523 HeUTF8(entry)) )
2524 {
2525 const char *file;
2526 gv = MUTABLE_GV(HeVAL(entry));
2527 if (SvTYPE(gv) != SVt_PVGV || GvMULTI(gv))
2528 continue;
2529 file = GvFILE(gv);
2530 CopLINE_set(PL_curcop, GvLINE(gv));
2531#ifdef USE_ITHREADS
2532 CopFILE(PL_curcop) = (char *)file; /* set for warning */
2533#else
2534 CopFILEGV(PL_curcop)
2535 = gv_fetchfile_flags(file, HEK_LEN(GvFILE_HEK(gv)), 0);
2536#endif
2537 Perl_warner(aTHX_ packWARN(WARN_ONCE),
2538 "Name \"%" HEKf "::%" HEKf
2539 "\" used only once: possible typo",
2540 HEKfARG(HvNAME_HEK(stash)),
2541 HEKfARG(GvNAME_HEK(gv)));
2542 }
2543 }
2544 HvAUX(stash)->xhv_aux_flags &= ~HvAUXf_SCAN_STASH;
2545 }
2546}
2547
2548GV *
2549Perl_newGVgen_flags(pTHX_ const char *pack, U32 flags)
2550{
2551 PERL_ARGS_ASSERT_NEWGVGEN_FLAGS;
2552 assert(!(flags & ~SVf_UTF8));
2553
2554 return gv_fetchpv(Perl_form(aTHX_ "%" UTF8f "::_GEN_%ld",
2555 UTF8fARG(flags, strlen(pack), pack),
2556 (long)PL_gensym++),
2557 GV_ADD, SVt_PVGV);
2558}
2559
2560/* hopefully this is only called on local symbol table entries */
2561
2562GP*
2563Perl_gp_ref(pTHX_ GP *gp)
2564{
2565 if (!gp)
2566 return NULL;
2567 gp->gp_refcnt++;
2568 if (gp->gp_cv) {
2569 if (gp->gp_cvgen) {
2570 /* If the GP they asked for a reference to contains
2571 a method cache entry, clear it first, so that we
2572 don't infect them with our cached entry */
2573 SvREFCNT_dec_NN(gp->gp_cv);
2574 gp->gp_cv = NULL;
2575 gp->gp_cvgen = 0;
2576 }
2577 }
2578 return gp;
2579}
2580
2581void
2582Perl_gp_free(pTHX_ GV *gv)
2583{
2584 GP* gp;
2585 int attempts = 100;
2586
2587 if (!gv || !isGV_with_GP(gv) || !(gp = GvGP(gv)))
2588 return;
2589 if (gp->gp_refcnt == 0) {
2590 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
2591 "Attempt to free unreferenced glob pointers"
2592 pTHX__FORMAT pTHX__VALUE);
2593 return;
2594 }
2595 if (gp->gp_refcnt > 1) {
2596 borrowed:
2597 if (gp->gp_egv == gv)
2598 gp->gp_egv = 0;
2599 gp->gp_refcnt--;
2600 GvGP_set(gv, NULL);
2601 return;
2602 }
2603
2604 while (1) {
2605 /* Copy and null out all the glob slots, so destructors do not see
2606 freed SVs. */
2607 HEK * const file_hek = gp->gp_file_hek;
2608 SV * const sv = gp->gp_sv;
2609 AV * const av = gp->gp_av;
2610 HV * const hv = gp->gp_hv;
2611 IO * const io = gp->gp_io;
2612 CV * const cv = gp->gp_cv;
2613 CV * const form = gp->gp_form;
2614
2615 gp->gp_file_hek = NULL;
2616 gp->gp_sv = NULL;
2617 gp->gp_av = NULL;
2618 gp->gp_hv = NULL;
2619 gp->gp_io = NULL;
2620 gp->gp_cv = NULL;
2621 gp->gp_form = NULL;
2622
2623 if (file_hek)
2624 unshare_hek(file_hek);
2625
2626 SvREFCNT_dec(sv);
2627 SvREFCNT_dec(av);
2628 /* FIXME - another reference loop GV -> symtab -> GV ?
2629 Somehow gp->gp_hv can end up pointing at freed garbage. */
2630 if (hv && SvTYPE(hv) == SVt_PVHV) {
2631 const HEK *hvname_hek = HvNAME_HEK(hv);
2632 if (PL_stashcache && hvname_hek) {
2633 DEBUG_o(Perl_deb(aTHX_
2634 "gp_free clearing PL_stashcache for '%" HEKf "'\n",
2635 HEKfARG(hvname_hek)));
2636 (void)hv_deletehek(PL_stashcache, hvname_hek, G_DISCARD);
2637 }
2638 SvREFCNT_dec(hv);
2639 }
2640 if (io && SvREFCNT(io) == 1 && IoIFP(io)
2641 && (IoTYPE(io) == IoTYPE_WRONLY ||
2642 IoTYPE(io) == IoTYPE_RDWR ||
2643 IoTYPE(io) == IoTYPE_APPEND)
2644 && ckWARN_d(WARN_IO)
2645 && IoIFP(io) != PerlIO_stdin()
2646 && IoIFP(io) != PerlIO_stdout()
2647 && IoIFP(io) != PerlIO_stderr()
2648 && !(IoFLAGS(io) & IOf_FAKE_DIRP))
2649 io_close(io, gv, FALSE, TRUE);
2650 SvREFCNT_dec(io);
2651 SvREFCNT_dec(cv);
2652 SvREFCNT_dec(form);
2653
2654 /* Possibly reallocated by a destructor */
2655 gp = GvGP(gv);
2656
2657 if (!gp->gp_file_hek
2658 && !gp->gp_sv
2659 && !gp->gp_av
2660 && !gp->gp_hv
2661 && !gp->gp_io
2662 && !gp->gp_cv
2663 && !gp->gp_form) break;
2664
2665 if (--attempts == 0) {
2666 Perl_die(aTHX_
2667 "panic: gp_free failed to free glob pointer - "
2668 "something is repeatedly re-creating entries"
2669 );
2670 }
2671 }
2672
2673 /* Possibly incremented by a destructor doing glob assignment */
2674 if (gp->gp_refcnt > 1) goto borrowed;
2675 Safefree(gp);
2676 GvGP_set(gv, NULL);
2677}
2678
2679int
2680Perl_magic_freeovrld(pTHX_ SV *sv, MAGIC *mg)
2681{
2682 AMT * const amtp = (AMT*)mg->mg_ptr;
2683 PERL_UNUSED_ARG(sv);
2684
2685 PERL_ARGS_ASSERT_MAGIC_FREEOVRLD;
2686
2687 if (amtp && AMT_AMAGIC(amtp)) {
2688 int i;
2689 for (i = 1; i < NofAMmeth; i++) {
2690 CV * const cv = amtp->table[i];
2691 if (cv) {
2692 SvREFCNT_dec_NN(MUTABLE_SV(cv));
2693 amtp->table[i] = NULL;
2694 }
2695 }
2696 }
2697 return 0;
2698}
2699
2700/* Updates and caches the CV's */
2701/* Returns:
2702 * 1 on success and there is some overload
2703 * 0 if there is no overload
2704 * -1 if some error occurred and it couldn't croak
2705 */
2706
2707int
2708Perl_Gv_AMupdate(pTHX_ HV *stash, bool destructing)
2709{
2710 MAGIC* const mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
2711 AMT amt;
2712 const struct mro_meta* stash_meta = HvMROMETA(stash);
2713 U32 newgen;
2714
2715 PERL_ARGS_ASSERT_GV_AMUPDATE;
2716
2717 newgen = PL_sub_generation + stash_meta->pkg_gen + stash_meta->cache_gen;
2718 if (mg) {
2719 const AMT * const amtp = (AMT*)mg->mg_ptr;
2720 if (amtp->was_ok_sub == newgen) {
2721 return AMT_AMAGIC(amtp) ? 1 : 0;
2722 }
2723 sv_unmagic(MUTABLE_SV(stash), PERL_MAGIC_overload_table);
2724 }
2725
2726 DEBUG_o( Perl_deb(aTHX_ "Recalcing overload magic in package %s\n",HvNAME_get(stash)) );
2727
2728 Zero(&amt,1,AMT);
2729 amt.was_ok_sub = newgen;
2730 amt.fallback = AMGfallNO;
2731 amt.flags = 0;
2732
2733 {
2734 int filled = 0;
2735 int i;
2736 bool deref_seen = 0;
2737
2738
2739 /* Work with "fallback" key, which we assume to be first in PL_AMG_names */
2740
2741 /* Try to find via inheritance. */
2742 GV *gv = gv_fetchmeth_pvn(stash, PL_AMG_names[0], 2, -1, 0);
2743 SV * const sv = gv ? GvSV(gv) : NULL;
2744 CV* cv;
2745
2746 if (!gv)
2747 {
2748 if (!gv_fetchmeth_pvn(stash, "((", 2, -1, 0))
2749 goto no_table;
2750 }
2751#ifdef PERL_DONT_CREATE_GVSV
2752 else if (!sv) {
2753 NOOP; /* Equivalent to !SvTRUE and !SvOK */
2754 }
2755#endif
2756 else if (SvTRUE(sv))
2757 /* don't need to set overloading here because fallback => 1
2758 * is the default setting for classes without overloading */
2759 amt.fallback=AMGfallYES;
2760 else if (SvOK(sv)) {
2761 amt.fallback=AMGfallNEVER;
2762 filled = 1;
2763 }
2764 else {
2765 filled = 1;
2766 }
2767
2768 assert(SvOOK(stash));
2769 /* initially assume the worst */
2770 HvAUX(stash)->xhv_aux_flags &= ~HvAUXf_NO_DEREF;
2771
2772 for (i = 1; i < NofAMmeth; i++) {
2773 const char * const cooky = PL_AMG_names[i];
2774 /* Human-readable form, for debugging: */
2775 const char * const cp = AMG_id2name(i);
2776 const STRLEN l = PL_AMG_namelens[i];
2777
2778 DEBUG_o( Perl_deb(aTHX_ "Checking overloading of \"%s\" in package \"%.256s\"\n",
2779 cp, HvNAME_get(stash)) );
2780 /* don't fill the cache while looking up!
2781 Creation of inheritance stubs in intermediate packages may
2782 conflict with the logic of runtime method substitution.
2783 Indeed, for inheritance A -> B -> C, if C overloads "+0",
2784 then we could have created stubs for "(+0" in A and C too.
2785 But if B overloads "bool", we may want to use it for
2786 numifying instead of C's "+0". */
2787 gv = Perl_gv_fetchmeth_pvn(aTHX_ stash, cooky, l, -1, 0);
2788 cv = 0;
2789 if (gv && (cv = GvCV(gv)) && CvHASGV(cv)) {
2790 const HEK * const gvhek =
2791 CvNAMED(cv) ? CvNAME_HEK(cv) : GvNAME_HEK(CvGV(cv));
2792 const HEK * const stashek =
2793 HvNAME_HEK(CvNAMED(cv) ? CvSTASH(cv) : GvSTASH(CvGV(cv)));
2794 if (HEK_LEN(gvhek) == 3 && strEQ(HEK_KEY(gvhek), "nil")
2795 && stashek && HEK_LEN(stashek) == 8
2796 && strEQ(HEK_KEY(stashek), "overload")) {
2797 /* This is a hack to support autoloading..., while
2798 knowing *which* methods were declared as overloaded. */
2799 /* GvSV contains the name of the method. */
2800 GV *ngv = NULL;
2801 SV *gvsv = GvSV(gv);
2802
2803 DEBUG_o( Perl_deb(aTHX_ "Resolving method \"%" SVf256\
2804 "\" for overloaded \"%s\" in package \"%.256s\"\n",
2805 (void*)GvSV(gv), cp, HvNAME(stash)) );
2806 if (!gvsv || !SvPOK(gvsv)
2807 || !(ngv = gv_fetchmethod_sv_flags(stash, gvsv, 0)))
2808 {
2809 /* Can be an import stub (created by "can"). */
2810 if (destructing) {
2811 return -1;
2812 }
2813 else {
2814 const SV * const name = (gvsv && SvPOK(gvsv))
2815 ? gvsv
2816 : newSVpvs_flags("???", SVs_TEMP);
2817 /* diag_listed_as: Can't resolve method "%s" overloading "%s" in package "%s" */
2818 Perl_croak(aTHX_ "%s method \"%" SVf256
2819 "\" overloading \"%s\" "\
2820 "in package \"%" HEKf256 "\"",
2821 (GvCVGEN(gv) ? "Stub found while resolving"
2822 : "Can't resolve"),
2823 SVfARG(name), cp,
2824 HEKfARG(
2825 HvNAME_HEK(stash)
2826 ));
2827 }
2828 }
2829 cv = GvCV(gv = ngv);
2830 }
2831 DEBUG_o( Perl_deb(aTHX_ "Overloading \"%s\" in package \"%.256s\" via \"%.256s::%.256s\"\n",
2832 cp, HvNAME_get(stash), HvNAME_get(GvSTASH(CvGV(cv))),
2833 GvNAME(CvGV(cv))) );
2834 filled = 1;
2835 } else if (gv) { /* Autoloaded... */
2836 cv = MUTABLE_CV(gv);
2837 filled = 1;
2838 }
2839 amt.table[i]=MUTABLE_CV(SvREFCNT_inc_simple(cv));
2840
2841 if (gv) {
2842 switch (i) {
2843 case to_sv_amg:
2844 case to_av_amg:
2845 case to_hv_amg:
2846 case to_gv_amg:
2847 case to_cv_amg:
2848 case nomethod_amg:
2849 deref_seen = 1;
2850 break;
2851 }
2852 }
2853 }
2854 if (!deref_seen)
2855 /* none of @{} etc overloaded; we can do $obj->[N] quicker.
2856 * NB - aux var invalid here, HvARRAY() could have been
2857 * reallocated since it was assigned to */
2858 HvAUX(stash)->xhv_aux_flags |= HvAUXf_NO_DEREF;
2859
2860 if (filled) {
2861 AMT_AMAGIC_on(&amt);
2862 sv_magic(MUTABLE_SV(stash), 0, PERL_MAGIC_overload_table,
2863 (char*)&amt, sizeof(AMT));
2864 return TRUE;
2865 }
2866 }
2867 /* Here we have no table: */
2868 no_table:
2869 AMT_AMAGIC_off(&amt);
2870 sv_magic(MUTABLE_SV(stash), 0, PERL_MAGIC_overload_table,
2871 (char*)&amt, sizeof(AMTS));
2872 return 0;
2873}
2874
2875
2876CV*
2877Perl_gv_handler(pTHX_ HV *stash, I32 id)
2878{
2879 MAGIC *mg;
2880 AMT *amtp;
2881 U32 newgen;
2882 struct mro_meta* stash_meta;
2883
2884 if (!stash || !HvNAME_get(stash))
2885 return NULL;
2886
2887 stash_meta = HvMROMETA(stash);
2888 newgen = PL_sub_generation + stash_meta->pkg_gen + stash_meta->cache_gen;
2889
2890 mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
2891 if (!mg) {
2892 do_update:
2893 if (Gv_AMupdate(stash, 0) == -1)
2894 return NULL;
2895 mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
2896 }
2897 assert(mg);
2898 amtp = (AMT*)mg->mg_ptr;
2899 if ( amtp->was_ok_sub != newgen )
2900 goto do_update;
2901 if (AMT_AMAGIC(amtp)) {
2902 CV * const ret = amtp->table[id];
2903 if (ret && isGV(ret)) { /* Autoloading stab */
2904 /* Passing it through may have resulted in a warning
2905 "Inherited AUTOLOAD for a non-method deprecated", since
2906 our caller is going through a function call, not a method call.
2907 So return the CV for AUTOLOAD, setting $AUTOLOAD. */
2908 GV * const gv = gv_fetchmethod(stash, PL_AMG_names[id]);
2909
2910 if (gv && GvCV(gv))
2911 return GvCV(gv);
2912 }
2913 return ret;
2914 }
2915
2916 return NULL;
2917}
2918
2919
2920/* Implement tryAMAGICun_MG macro.
2921 Do get magic, then see if the stack arg is overloaded and if so call it.
2922 Flags:
2923 AMGf_set return the arg using SETs rather than assigning to
2924 the targ
2925 AMGf_numeric apply sv_2num to the stack arg.
2926*/
2927
2928bool
2929Perl_try_amagic_un(pTHX_ int method, int flags) {
2930 dSP;
2931 SV* tmpsv;
2932 SV* const arg = TOPs;
2933
2934 SvGETMAGIC(arg);
2935
2936 if (SvAMAGIC(arg) && (tmpsv = amagic_call(arg, &PL_sv_undef, method,
2937 AMGf_noright | AMGf_unary
2938 | (flags & AMGf_numarg))))
2939 {
2940 if (flags & AMGf_set) {
2941 SETs(tmpsv);
2942 }
2943 else {
2944 dTARGET;
2945 if (SvPADMY(TARG)) {
2946 sv_setsv(TARG, tmpsv);
2947 SETTARG;
2948 }
2949 else
2950 SETs(tmpsv);
2951 }
2952 PUTBACK;
2953 return TRUE;
2954 }
2955
2956 if ((flags & AMGf_numeric) && SvROK(arg))
2957 *sp = sv_2num(arg);
2958 return FALSE;
2959}
2960
2961
2962/* Implement tryAMAGICbin_MG macro.
2963 Do get magic, then see if the two stack args are overloaded and if so
2964 call it.
2965 Flags:
2966 AMGf_set return the arg using SETs rather than assigning to
2967 the targ
2968 AMGf_assign op may be called as mutator (eg +=)
2969 AMGf_numeric apply sv_2num to the stack arg.
2970*/
2971
2972bool
2973Perl_try_amagic_bin(pTHX_ int method, int flags) {
2974 dSP;
2975 SV* const left = TOPm1s;
2976 SV* const right = TOPs;
2977
2978 SvGETMAGIC(left);
2979 if (left != right)
2980 SvGETMAGIC(right);
2981
2982 if (SvAMAGIC(left) || SvAMAGIC(right)) {
2983 SV * const tmpsv = amagic_call(left, right, method,
2984 ((flags & AMGf_assign) && opASSIGN ? AMGf_assign: 0)
2985 | (flags & AMGf_numarg));
2986 if (tmpsv) {
2987 if (flags & AMGf_set) {
2988 (void)POPs;
2989 SETs(tmpsv);
2990 }
2991 else {
2992 dATARGET;
2993 (void)POPs;
2994 if (opASSIGN || SvPADMY(TARG)) {
2995 sv_setsv(TARG, tmpsv);
2996 SETTARG;
2997 }
2998 else
2999 SETs(tmpsv);
3000 }
3001 PUTBACK;
3002 return TRUE;
3003 }
3004 }
3005 if(left==right && SvGMAGICAL(left)) {
3006 SV * const left = sv_newmortal();
3007 *(sp-1) = left;
3008 /* Print the uninitialized warning now, so it includes the vari-
3009 able name. */
3010 if (!SvOK(right)) {
3011 if (ckWARN(WARN_UNINITIALIZED)) report_uninit(right);
3012 sv_setsv_flags(left, &PL_sv_no, 0);
3013 }
3014 else sv_setsv_flags(left, right, 0);
3015 SvGETMAGIC(right);
3016 }
3017 if (flags & AMGf_numeric) {
3018 if (SvROK(TOPm1s))
3019 *(sp-1) = sv_2num(TOPm1s);
3020 if (SvROK(right))
3021 *sp = sv_2num(right);
3022 }
3023 return FALSE;
3024}
3025
3026SV *
3027Perl_amagic_deref_call(pTHX_ SV *ref, int method) {
3028 SV *tmpsv = NULL;
3029 HV *stash;
3030
3031 PERL_ARGS_ASSERT_AMAGIC_DEREF_CALL;
3032
3033 if (!SvAMAGIC(ref))
3034 return ref;
3035 /* return quickly if none of the deref ops are overloaded */
3036 stash = SvSTASH(SvRV(ref));
3037 assert(SvOOK(stash));
3038 if (HvAUX(stash)->xhv_aux_flags & HvAUXf_NO_DEREF)
3039 return ref;
3040
3041 while ((tmpsv = amagic_call(ref, &PL_sv_undef, method,
3042 AMGf_noright | AMGf_unary))) {
3043 if (!SvROK(tmpsv))
3044 Perl_croak(aTHX_ "Overloaded dereference did not return a reference");
3045 if (tmpsv == ref || SvRV(tmpsv) == SvRV(ref)) {
3046 /* Bail out if it returns us the same reference. */
3047 return tmpsv;
3048 }
3049 ref = tmpsv;
3050 if (!SvAMAGIC(ref))
3051 break;
3052 }
3053 return tmpsv ? tmpsv : ref;
3054}
3055
3056bool
3057Perl_amagic_is_enabled(pTHX_ int method)
3058{
3059 SV *lex_mask = cop_hints_fetch_pvs(PL_curcop, "overloading", 0);
3060
3061 assert(PL_curcop->cop_hints & HINT_NO_AMAGIC);
3062
3063 if ( !lex_mask || !SvOK(lex_mask) )
3064 /* overloading lexically disabled */
3065 return FALSE;
3066 else if ( lex_mask && SvPOK(lex_mask) ) {
3067 /* we have an entry in the hints hash, check if method has been
3068 * masked by overloading.pm */
3069 STRLEN len;
3070 const int offset = method / 8;
3071 const int bit = method % 8;
3072 char *pv = SvPV(lex_mask, len);
3073
3074 /* Bit set, so this overloading operator is disabled */
3075 if ( (STRLEN)offset < len && pv[offset] & ( 1 << bit ) )
3076 return FALSE;
3077 }
3078 return TRUE;
3079}
3080
3081SV*
3082Perl_amagic_call(pTHX_ SV *left, SV *right, int method, int flags)
3083{
3084 dVAR;
3085 MAGIC *mg;
3086 CV *cv=NULL;
3087 CV **cvp=NULL, **ocvp=NULL;
3088 AMT *amtp=NULL, *oamtp=NULL;
3089 int off = 0, off1, lr = 0, notfound = 0;
3090 int postpr = 0, force_cpy = 0;
3091 int assign = AMGf_assign & flags;
3092 const int assignshift = assign ? 1 : 0;
3093 int use_default_op = 0;
3094 int force_scalar = 0;
3095#ifdef DEBUGGING
3096 int fl=0;
3097#endif
3098 HV* stash=NULL;
3099
3100 PERL_ARGS_ASSERT_AMAGIC_CALL;
3101
3102 if ( PL_curcop->cop_hints & HINT_NO_AMAGIC ) {
3103 if (!amagic_is_enabled(method)) return NULL;
3104 }
3105
3106 if (!(AMGf_noleft & flags) && SvAMAGIC(left)
3107 && (stash = SvSTASH(SvRV(left))) && Gv_AMG(stash)
3108 && (mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table))
3109 && (ocvp = cvp = (AMT_AMAGIC((AMT*)mg->mg_ptr)
3110 ? (oamtp = amtp = (AMT*)mg->mg_ptr)->table
3111 : NULL))
3112 && ((cv = cvp[off=method+assignshift])
3113 || (assign && amtp->fallback > AMGfallNEVER && /* fallback to
3114 * usual method */
3115 (
3116#ifdef DEBUGGING
3117 fl = 1,
3118#endif
3119 cv = cvp[off=method])))) {
3120 lr = -1; /* Call method for left argument */
3121 } else {
3122 if (cvp && amtp->fallback > AMGfallNEVER && flags & AMGf_unary) {
3123 int logic;
3124
3125 /* look for substituted methods */
3126 /* In all the covered cases we should be called with assign==0. */
3127 switch (method) {
3128 case inc_amg:
3129 force_cpy = 1;
3130 if ((cv = cvp[off=add_ass_amg])
3131 || ((cv = cvp[off = add_amg]) && (force_cpy = 0, postpr = 1))) {
3132 right = &PL_sv_yes; lr = -1; assign = 1;
3133 }
3134 break;
3135 case dec_amg:
3136 force_cpy = 1;
3137 if ((cv = cvp[off = subtr_ass_amg])
3138 || ((cv = cvp[off = subtr_amg]) && (force_cpy = 0, postpr=1))) {
3139 right = &PL_sv_yes; lr = -1; assign = 1;
3140 }
3141 break;
3142 case bool__amg:
3143 (void)((cv = cvp[off=numer_amg]) || (cv = cvp[off=string_amg]));
3144 break;
3145 case numer_amg:
3146 (void)((cv = cvp[off=string_amg]) || (cv = cvp[off=bool__amg]));
3147 break;
3148 case string_amg:
3149 (void)((cv = cvp[off=numer_amg]) || (cv = cvp[off=bool__amg]));
3150 break;
3151 case not_amg:
3152 (void)((cv = cvp[off=bool__amg])
3153 || (cv = cvp[off=numer_amg])
3154 || (cv = cvp[off=string_amg]));
3155 if (cv)
3156 postpr = 1;
3157 break;
3158 case copy_amg:
3159 {
3160 /*
3161 * SV* ref causes confusion with the interpreter variable of
3162 * the same name
3163 */
3164 SV* const tmpRef=SvRV(left);
3165 if (!SvROK(tmpRef) && SvTYPE(tmpRef) <= SVt_PVMG) {
3166 /*
3167 * Just to be extra cautious. Maybe in some
3168 * additional cases sv_setsv is safe, too.
3169 */
3170 SV* const newref = newSVsv(tmpRef);
3171 SvOBJECT_on(newref);
3172 /* No need to do SvAMAGIC_on here, as SvAMAGIC macros
3173 delegate to the stash. */
3174 SvSTASH_set(newref, MUTABLE_HV(SvREFCNT_inc(SvSTASH(tmpRef))));
3175 return newref;
3176 }
3177 }
3178 break;
3179 case abs_amg:
3180 if ((cvp[off1=lt_amg] || cvp[off1=ncmp_amg])
3181 && ((cv = cvp[off=neg_amg]) || (cv = cvp[off=subtr_amg]))) {
3182 SV* const nullsv=sv_2mortal(newSViv(0));
3183 if (off1==lt_amg) {
3184 SV* const lessp = amagic_call(left,nullsv,
3185 lt_amg,AMGf_noright);
3186 logic = SvTRUE(lessp);
3187 } else {
3188 SV* const lessp = amagic_call(left,nullsv,
3189 ncmp_amg,AMGf_noright);
3190 logic = (SvNV(lessp) < 0);
3191 }
3192 if (logic) {
3193 if (off==subtr_amg) {
3194 right = left;
3195 left = nullsv;
3196 lr = 1;
3197 }
3198 } else {
3199 return left;
3200 }
3201 }
3202 break;
3203 case neg_amg:
3204 if ((cv = cvp[off=subtr_amg])) {
3205 right = left;
3206 left = sv_2mortal(newSViv(0));
3207 lr = 1;
3208 }
3209 break;
3210 case int_amg:
3211 case iter_amg: /* XXXX Eventually should do to_gv. */
3212 case ftest_amg: /* XXXX Eventually should do to_gv. */
3213 case regexp_amg:
3214 /* FAIL safe */
3215 return NULL; /* Delegate operation to standard mechanisms. */
3216
3217 case to_sv_amg:
3218 case to_av_amg:
3219 case to_hv_amg:
3220 case to_gv_amg:
3221 case to_cv_amg:
3222 /* FAIL safe */
3223 return left; /* Delegate operation to standard mechanisms. */
3224
3225 default:
3226 goto not_found;
3227 }
3228 if (!cv) goto not_found;
3229 } else if (!(AMGf_noright & flags) && SvAMAGIC(right)
3230 && (stash = SvSTASH(SvRV(right))) && Gv_AMG(stash)
3231 && (mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table))
3232 && (cvp = (AMT_AMAGIC((AMT*)mg->mg_ptr)
3233 ? (amtp = (AMT*)mg->mg_ptr)->table
3234 : NULL))
3235 && (cv = cvp[off=method])) { /* Method for right
3236 * argument found */
3237 lr=1;
3238 } else if (((cvp && amtp->fallback > AMGfallNEVER)
3239 || (ocvp && oamtp->fallback > AMGfallNEVER))
3240 && !(flags & AMGf_unary)) {
3241 /* We look for substitution for
3242 * comparison operations and
3243 * concatenation */
3244 if (method==concat_amg || method==concat_ass_amg
3245 || method==repeat_amg || method==repeat_ass_amg) {
3246 return NULL; /* Delegate operation to string conversion */
3247 }
3248 off = -1;
3249 switch (method) {
3250 case lt_amg:
3251 case le_amg:
3252 case gt_amg:
3253 case ge_amg:
3254 case eq_amg:
3255 case ne_amg:
3256 off = ncmp_amg;
3257 break;
3258 case slt_amg:
3259 case sle_amg:
3260 case sgt_amg:
3261 case sge_amg:
3262 case seq_amg:
3263 case sne_amg:
3264 off = scmp_amg;
3265 break;
3266 }
3267 if (off != -1) {
3268 if (ocvp && (oamtp->fallback > AMGfallNEVER)) {
3269 cv = ocvp[off];
3270 lr = -1;
3271 }
3272 if (!cv && (cvp && amtp->fallback > AMGfallNEVER)) {
3273 cv = cvp[off];
3274 lr = 1;
3275 }
3276 }
3277 if (cv)
3278 postpr = 1;
3279 else
3280 goto not_found;
3281 } else {
3282 not_found: /* No method found, either report or croak */
3283 switch (method) {
3284 case to_sv_amg:
3285 case to_av_amg:
3286 case to_hv_amg:
3287 case to_gv_amg:
3288 case to_cv_amg:
3289 /* FAIL safe */
3290 return left; /* Delegate operation to standard mechanisms. */
3291 }
3292 if (ocvp && (cv=ocvp[nomethod_amg])) { /* Call report method */
3293 notfound = 1; lr = -1;
3294 } else if (cvp && (cv=cvp[nomethod_amg])) {
3295 notfound = 1; lr = 1;
3296 } else if ((use_default_op =
3297 (!ocvp || oamtp->fallback >= AMGfallYES)
3298 && (!cvp || amtp->fallback >= AMGfallYES))
3299 && !DEBUG_o_TEST) {
3300 /* Skip generating the "no method found" message. */
3301 return NULL;
3302 } else {
3303 SV *msg;
3304 if (off==-1) off=method;
3305 msg = sv_2mortal(Perl_newSVpvf(aTHX_
3306 "Operation \"%s\": no method found,%sargument %s%" SVf "%s%" SVf,
3307 AMG_id2name(method + assignshift),
3308 (flags & AMGf_unary ? " " : "\n\tleft "),
3309 SvAMAGIC(left)?
3310 "in overloaded package ":
3311 "has no overloaded magic",
3312 SvAMAGIC(left)?
3313 SVfARG(sv_2mortal(newSVhek(HvNAME_HEK(SvSTASH(SvRV(left)))))):
3314 SVfARG(&PL_sv_no),
3315 SvAMAGIC(right)?
3316 ",\n\tright argument in overloaded package ":
3317 (flags & AMGf_unary
3318 ? ""
3319 : ",\n\tright argument has no overloaded magic"),
3320 SvAMAGIC(right)?
3321 SVfARG(sv_2mortal(newSVhek(HvNAME_HEK(SvSTASH(SvRV(right)))))):
3322 SVfARG(&PL_sv_no)));
3323 if (use_default_op) {
3324 DEBUG_o( Perl_deb(aTHX_ "%" SVf, SVfARG(msg)) );
3325 } else {
3326 Perl_croak(aTHX_ "%" SVf, SVfARG(msg));
3327 }
3328 return NULL;
3329 }
3330 force_cpy = force_cpy || assign;
3331 }
3332 }
3333
3334 switch (method) {
3335 /* in these cases, we're calling '+' or '-' as a fallback for a ++ or --
3336 * operation. we need this to return a value, so that it can be assigned
3337 * later on, in the postpr block (case inc_amg/dec_amg), even if the
3338 * increment or decrement was itself called in void context */
3339 case inc_amg:
3340 if (off == add_amg)
3341 force_scalar = 1;
3342 break;
3343 case dec_amg:
3344 if (off == subtr_amg)
3345 force_scalar = 1;
3346 break;
3347 /* in these cases, we're calling an assignment variant of an operator
3348 * (+= rather than +, for instance). regardless of whether it's a
3349 * fallback or not, it always has to return a value, which will be
3350 * assigned to the proper variable later */
3351 case add_amg:
3352 case subtr_amg:
3353 case mult_amg:
3354 case div_amg:
3355 case modulo_amg:
3356 case pow_amg:
3357 case lshift_amg:
3358 case rshift_amg:
3359 case repeat_amg:
3360 case concat_amg:
3361 case band_amg:
3362 case bor_amg:
3363 case bxor_amg:
3364 case sband_amg:
3365 case sbor_amg:
3366 case sbxor_amg:
3367 if (assign)
3368 force_scalar = 1;
3369 break;
3370 /* the copy constructor always needs to return a value */
3371 case copy_amg:
3372 force_scalar = 1;
3373 break;
3374 /* because of the way these are implemented (they don't perform the
3375 * dereferencing themselves, they return a reference that perl then
3376 * dereferences later), they always have to be in scalar context */
3377 case to_sv_amg:
3378 case to_av_amg:
3379 case to_hv_amg:
3380 case to_gv_amg:
3381 case to_cv_amg:
3382 force_scalar = 1;
3383 break;
3384 /* these don't have an op of their own; they're triggered by their parent
3385 * op, so the context there isn't meaningful ('$a and foo()' in void
3386 * context still needs to pass scalar context on to $a's bool overload) */
3387 case bool__amg:
3388 case numer_amg:
3389 case string_amg:
3390 force_scalar = 1;
3391 break;
3392 }
3393
3394#ifdef DEBUGGING
3395 if (!notfound) {
3396 DEBUG_o(Perl_deb(aTHX_
3397 "Overloaded operator \"%s\"%s%s%s:\n\tmethod%s found%s in package %" SVf "%s\n",
3398 AMG_id2name(off),
3399 method+assignshift==off? "" :
3400 " (initially \"",
3401 method+assignshift==off? "" :
3402 AMG_id2name(method+assignshift),
3403 method+assignshift==off? "" : "\")",
3404 flags & AMGf_unary? "" :
3405 lr==1 ? " for right argument": " for left argument",
3406 flags & AMGf_unary? " for argument" : "",
3407 stash ? SVfARG(sv_2mortal(newSVhek(HvNAME_HEK(stash)))) : SVfARG(newSVpvs_flags("null", SVs_TEMP)),
3408 fl? ",\n\tassignment variant used": "") );
3409 }
3410#endif
3411 /* Since we use shallow copy during assignment, we need
3412 * to dublicate the contents, probably calling user-supplied
3413 * version of copy operator
3414 */
3415 /* We need to copy in following cases:
3416 * a) Assignment form was called.
3417 * assignshift==1, assign==T, method + 1 == off
3418 * b) Increment or decrement, called directly.
3419 * assignshift==0, assign==0, method + 0 == off
3420 * c) Increment or decrement, translated to assignment add/subtr.
3421 * assignshift==0, assign==T,
3422 * force_cpy == T
3423 * d) Increment or decrement, translated to nomethod.
3424 * assignshift==0, assign==0,
3425 * force_cpy == T
3426 * e) Assignment form translated to nomethod.
3427 * assignshift==1, assign==T, method + 1 != off
3428 * force_cpy == T
3429 */
3430 /* off is method, method+assignshift, or a result of opcode substitution.
3431 * In the latter case assignshift==0, so only notfound case is important.
3432 */
3433 if ( (lr == -1) && ( ( (method + assignshift == off)
3434 && (assign || (method == inc_amg) || (method == dec_amg)))
3435 || force_cpy) )
3436 {
3437 /* newSVsv does not behave as advertised, so we copy missing
3438 * information by hand */
3439 SV *tmpRef = SvRV(left);
3440 SV *rv_copy;
3441 if (SvREFCNT(tmpRef) > 1 && (rv_copy = AMG_CALLunary(left,copy_amg))) {
3442 SvRV_set(left, rv_copy);
3443 SvSETMAGIC(left);
3444 SvREFCNT_dec_NN(tmpRef);
3445 }
3446 }
3447
3448 {
3449 dSP;
3450 BINOP myop;
3451 SV* res;
3452 const bool oldcatch = CATCH_GET;
3453 I32 oldmark, nret;
3454 U8 gimme = force_scalar ? G_SCALAR : GIMME_V;
3455
3456 CATCH_SET(TRUE);
3457 Zero(&myop, 1, BINOP);
3458 myop.op_last = (OP *) &myop;
3459 myop.op_next = NULL;
3460 myop.op_flags = OPf_STACKED;
3461
3462 switch (gimme) {
3463 case G_VOID:
3464 myop.op_flags |= OPf_WANT_VOID;
3465 break;
3466 case G_ARRAY:
3467 if (flags & AMGf_want_list) {
3468 myop.op_flags |= OPf_WANT_LIST;
3469 break;
3470 }
3471 /* FALLTHROUGH */
3472 default:
3473 myop.op_flags |= OPf_WANT_SCALAR;
3474 break;
3475 }
3476
3477 PUSHSTACKi(PERLSI_OVERLOAD);
3478 ENTER;
3479 SAVEOP();
3480 PL_op = (OP *) &myop;
3481 if (PERLDB_SUB && PL_curstash != PL_debstash)
3482 PL_op->op_private |= OPpENTERSUB_DB;
3483 Perl_pp_pushmark(aTHX);
3484
3485 EXTEND(SP, notfound + 5);
3486 PUSHs(lr>0? right: left);
3487 PUSHs(lr>0? left: right);
3488 PUSHs( lr > 0 ? &PL_sv_yes : ( assign ? &PL_sv_undef : &PL_sv_no ));
3489 if (notfound) {
3490 PUSHs(newSVpvn_flags(AMG_id2name(method + assignshift),
3491 AMG_id2namelen(method + assignshift), SVs_TEMP));
3492 }
3493 else if (flags & AMGf_numarg)
3494 PUSHs(&PL_sv_undef);
3495 if (flags & AMGf_numarg)
3496 PUSHs(&PL_sv_yes);
3497 PUSHs(MUTABLE_SV(cv));
3498 PUTBACK;
3499 oldmark = TOPMARK;
3500
3501 if ((PL_op = PL_ppaddr[OP_ENTERSUB](aTHX)))
3502 CALLRUNOPS(aTHX);
3503 LEAVE;
3504 SPAGAIN;
3505 nret = SP - (PL_stack_base + oldmark);
3506
3507 switch (gimme) {
3508 case G_VOID:
3509 /* returning NULL has another meaning, and we check the context
3510 * at the call site too, so this can be differentiated from the
3511 * scalar case */
3512 res = &PL_sv_undef;
3513 SP = PL_stack_base + oldmark;
3514 break;
3515 case G_ARRAY: {
3516 if (flags & AMGf_want_list) {
3517 res = sv_2mortal((SV *)newAV());
3518 av_extend((AV *)res, nret);
3519 while (nret--)
3520 av_store((AV *)res, nret, POPs);
3521 break;
3522 }
3523 /* FALLTHROUGH */
3524 }
3525 default:
3526 res = POPs;
3527 break;
3528 }
3529
3530 PUTBACK;
3531 POPSTACK;
3532 CATCH_SET(oldcatch);
3533
3534 if (postpr) {
3535 int ans;
3536 switch (method) {
3537 case le_amg:
3538 case sle_amg:
3539 ans=SvIV(res)<=0; break;
3540 case lt_amg:
3541 case slt_amg:
3542 ans=SvIV(res)<0; break;
3543 case ge_amg:
3544 case sge_amg:
3545 ans=SvIV(res)>=0; break;
3546 case gt_amg:
3547 case sgt_amg:
3548 ans=SvIV(res)>0; break;
3549 case eq_amg:
3550 case seq_amg:
3551 ans=SvIV(res)==0; break;
3552 case ne_amg:
3553 case sne_amg:
3554 ans=SvIV(res)!=0; break;
3555 case inc_amg:
3556 case dec_amg:
3557 SvSetSV(left,res); return left;
3558 case not_amg:
3559 ans=!SvTRUE(res); break;
3560 default:
3561 ans=0; break;
3562 }
3563 return boolSV(ans);
3564 } else if (method==copy_amg) {
3565 if (!SvROK(res)) {
3566 Perl_croak(aTHX_ "Copy method did not return a reference");
3567 }
3568 return SvREFCNT_inc(SvRV(res));
3569 } else {
3570 return res;
3571 }
3572 }
3573}
3574
3575void
3576Perl_gv_name_set(pTHX_ GV *gv, const char *name, U32 len, U32 flags)
3577{
3578 dVAR;
3579 U32 hash;
3580
3581 PERL_ARGS_ASSERT_GV_NAME_SET;
3582
3583 if (len > I32_MAX)
3584 Perl_croak(aTHX_ "panic: gv name too long (%" UVuf ")", (UV) len);
3585
3586 if (!(flags & GV_ADD) && GvNAME_HEK(gv)) {
3587 unshare_hek(GvNAME_HEK(gv));
3588 }
3589
3590 PERL_HASH(hash, name, len);
3591 GvNAME_HEK(gv) = share_hek(name, (flags & SVf_UTF8 ? -(I32)len : (I32)len), hash);
3592}
3593
3594/*
3595=for apidoc gv_try_downgrade
3596
3597If the typeglob C<gv> can be expressed more succinctly, by having
3598something other than a real GV in its place in the stash, replace it
3599with the optimised form. Basic requirements for this are that C<gv>
3600is a real typeglob, is sufficiently ordinary, and is only referenced
3601from its package. This function is meant to be used when a GV has been
3602looked up in part to see what was there, causing upgrading, but based
3603on what was found it turns out that the real GV isn't required after all.
3604
3605If C<gv> is a completely empty typeglob, it is deleted from the stash.
3606
3607If C<gv> is a typeglob containing only a sufficiently-ordinary constant
3608sub, the typeglob is replaced with a scalar-reference placeholder that
3609more compactly represents the same thing.
3610
3611=cut
3612*/
3613
3614void
3615Perl_gv_try_downgrade(pTHX_ GV *gv)
3616{
3617 HV *stash;
3618 CV *cv;
3619 HEK *namehek;
3620 SV **gvp;
3621 PERL_ARGS_ASSERT_GV_TRY_DOWNGRADE;
3622
3623 /* XXX Why and where does this leave dangling pointers during global
3624 destruction? */
3625 if (PL_phase == PERL_PHASE_DESTRUCT) return;
3626
3627 if (!(SvREFCNT(gv) == 1 && SvTYPE(gv) == SVt_PVGV && !SvFAKE(gv) &&
3628 !SvOBJECT(gv) && !SvREADONLY(gv) &&
3629 isGV_with_GP(gv) && GvGP(gv) &&
3630 !GvINTRO(gv) && GvREFCNT(gv) == 1 &&
3631 !GvSV(gv) && !GvAV(gv) && !GvHV(gv) && !GvIOp(gv) && !GvFORM(gv) &&
3632 GvEGVx(gv) == gv && (stash = GvSTASH(gv))))
3633 return;
3634 if (gv == PL_statgv || gv == PL_last_in_gv || gv == PL_stderrgv)
3635 return;
3636 if (SvMAGICAL(gv)) {
3637 MAGIC *mg;
3638 /* only backref magic is allowed */
3639 if (SvGMAGICAL(gv) || SvSMAGICAL(gv))
3640 return;
3641 for (mg = SvMAGIC(gv); mg; mg = mg->mg_moremagic) {
3642 if (mg->mg_type != PERL_MAGIC_backref)
3643 return;
3644 }
3645 }
3646 cv = GvCV(gv);
3647 if (!cv) {
3648 HEK *gvnhek = GvNAME_HEK(gv);
3649 (void)hv_deletehek(stash, gvnhek, G_DISCARD);
3650 } else if (GvMULTI(gv) && cv && SvREFCNT(cv) == 1 &&
3651 !SvOBJECT(cv) && !SvMAGICAL(cv) && !SvREADONLY(cv) &&
3652 CvSTASH(cv) == stash && !CvNAMED(cv) && CvGV(cv) == gv &&
3653 CvCONST(cv) && !CvMETHOD(cv) && !CvLVALUE(cv) && !CvUNIQUE(cv) &&
3654 !CvNODEBUG(cv) && !CvCLONE(cv) && !CvCLONED(cv) && !CvANON(cv) &&
3655 (namehek = GvNAME_HEK(gv)) &&
3656 (gvp = hv_fetchhek(stash, namehek, 0)) &&
3657 *gvp == (SV*)gv) {
3658 SV *value = SvREFCNT_inc(CvXSUBANY(cv).any_ptr);
3659 const bool imported = !!GvIMPORTED_CV(gv);
3660 SvREFCNT(gv) = 0;
3661 sv_clear((SV*)gv);
3662 SvREFCNT(gv) = 1;
3663 SvFLAGS(gv) = SVt_IV|SVf_ROK|SVprv_PCS_IMPORTED * imported;
3664
3665 /* See also: 'SET_SVANY_FOR_BODYLESS_IV' in sv.c */
3666 SvANY(gv) = (XPVGV*)((char*)&(gv->sv_u.svu_iv) -
3667 STRUCT_OFFSET(XPVIV, xiv_iv));
3668 SvRV_set(gv, value);
3669 }
3670}
3671
3672GV *
3673Perl_gv_override(pTHX_ const char * const name, const STRLEN len)
3674{
3675 GV *gv = gv_fetchpvn(name, len, GV_NOTQUAL, SVt_PVCV);
3676 GV * const *gvp;
3677 PERL_ARGS_ASSERT_GV_OVERRIDE;
3678 if (gv && GvCVu(gv) && GvIMPORTED_CV(gv)) return gv;
3679 gvp = (GV**)hv_fetch(PL_globalstash, name, len, FALSE);
3680 gv = gvp ? *gvp : NULL;
3681 if (gv && !isGV(gv)) {
3682 if (!SvPCS_IMPORTED(gv)) return NULL;
3683 gv_init(gv, PL_globalstash, name, len, 0);
3684 return gv;
3685 }
3686 return gv && GvCVu(gv) && GvIMPORTED_CV(gv) ? gv : NULL;
3687}
3688
3689#include "XSUB.h"
3690
3691static void
3692core_xsub(pTHX_ CV* cv)
3693{
3694 Perl_croak(aTHX_
3695 "&CORE::%s cannot be called directly", GvNAME(CvGV(cv))
3696 );
3697}
3698
3699/*
3700 * ex: set ts=8 sts=4 sw=4 et:
3701 */