gv.c:require_tie_mod: Accept pvn params
[perl.git] / gv.c
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
24 A GV is a structure which corresponds to to a Perl typeglob, ie *foo.
25 It is a structure that holds a pointer to a scalar, an array, a hash etc,
26 corresponding to $foo, @foo, %foo.
27
28 GVs are usually found as values in stashes (symbol table hashes) where
29 Perl 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
41 static const char S_autoload[] = "AUTOLOAD";
42 #define S_autolen (sizeof("AUTOLOAD")-1)
43
44 GV *
45 Perl_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              && strnEQ(GvNAME(gv), "ISA", 3))
88             sv_magic(*where, (SV *)gv, PERL_MAGIC_isa, NULL, 0);
89     }
90     return gv;
91 }
92
93 GV *
94 Perl_gv_fetchfile(pTHX_ const char *name)
95 {
96     PERL_ARGS_ASSERT_GV_FETCHFILE;
97     return gv_fetchfile_flags(name, strlen(name), 0);
98 }
99
100 GV *
101 Perl_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
142 If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
143 inlining, or C<gv> is a placeholder reference that would be promoted to such
144 a typeglob, then returns the value returned by the sub.  Otherwise, returns
145 C<NULL>.
146
147 =cut
148 */
149
150 SV *
151 Perl_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
161 GP *
162 Perl_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
216 void
217 Perl_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
259 GV *
260 Perl_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
288 void
289 Perl_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
305 Converts a scalar into a typeglob.  This is an incoercible typeglob;
306 assigning a reference to it will assign to one of its slots, instead of
307 overwriting it as happens with typeglobs created by C<SvSetSV>.  Converting
308 any scalar that is C<SvOK()> may produce unpredictable results and is reserved
309 for perl's internal use.
310
311 C<gv> is the scalar to be converted.
312
313 C<stash> is the parent stash/package, if any.
314
315 C<name> and C<len> give the name.  The name must be unqualified;
316 that is, it must not include the package name.  If C<gv> is a
317 stash element, it is the caller's responsibility to ensure that the name
318 passed to this function matches the name of the element.  If it does not
319 match, perl's internal bookkeeping will get out of sync.
320
321 C<flags> can be set to C<SVf_UTF8> if C<name> is a UTF-8 string, or
322 the return value of SvUTF8(sv).  It can also take the
323 C<GV_ADDMULTI> flag, which means to pretend that the GV has been
324 seen before (i.e., suppress "Used once" warnings).
325
326 =for apidoc gv_init
327
328 The old form of C<gv_init_pvn()>.  It does not work with UTF-8 strings, as it
329 has no flags parameter.  If the C<multi> parameter is set, the
330 C<GV_ADDMULTI> flag will be passed to C<gv_init_pvn()>.
331
332 =for apidoc gv_init_pv
333
334 Same as C<gv_init_pvn()>, but takes a nul-terminated string for the name
335 instead of separate char * and length parameters.
336
337 =for apidoc gv_init_sv
338
339 Same as C<gv_init_pvn()>, but takes an SV * for the name instead of separate
340 char * and length parameters.  C<flags> is currently unused.
341
342 =cut
343 */
344
345 void
346 Perl_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
357 void
358 Perl_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
364 void
365 Perl_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
460 STATIC void
461 S_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
491 static void core_xsub(pTHX_ CV* cv);
492
493 static GV *
494 S_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
623 Like L</gv_fetchmeth_pvn>, but lacks a flags parameter.
624
625 =for apidoc gv_fetchmeth_sv
626
627 Exactly like L</gv_fetchmeth_pvn>, but takes the name string in the form
628 of an SV instead of a string/length pair.
629
630 =cut
631 */
632
633 GV *
634 Perl_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
649 Exactly like L</gv_fetchmeth_pvn>, but takes a nul-terminated string 
650 instead of a string/length pair.
651
652 =cut
653 */
654
655 GV *
656 Perl_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
665 Returns the glob with the given C<name> and a defined subroutine or
666 C<NULL>.  The glob lives in the given C<stash>, or in the stashes
667 accessible via C<@ISA> and C<UNIVERSAL::>.
668
669 The argument C<level> should be either 0 or -1.  If C<level==0>, as a
670 side-effect creates a glob with the given C<name> in the given C<stash>
671 which in the case of success contains an alias for the subroutine, and sets
672 up caching info for this glob.
673
674 The only significant values for C<flags> are C<GV_SUPER> and C<SVf_UTF8>.
675
676 C<GV_SUPER> indicates that we want to look up the method in the superclasses
677 of the C<stash>.
678
679 The
680 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
681 visible to Perl code.  So when calling C<call_sv>, you should not use
682 the GV directly; instead, you should use the method's CV, which can be
683 obtained from the GV with the C<GvCV> macro.
684
685 =cut
686 */
687
688 /* NOTE: No support for tied ISA */
689
690 PERL_STATIC_INLINE GV*
691 S_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, (flags & SVf_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               && strnEQ(hvname, "CORE", 4)
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 (strnEQ(hvname, "CORE", 4)
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
855 GV *
856 Perl_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
865 This is the old form of L</gv_fetchmeth_pvn_autoload>, which has no flags
866 parameter.
867
868 =for apidoc gv_fetchmeth_sv_autoload
869
870 Exactly like L</gv_fetchmeth_pvn_autoload>, but takes the name string in the form
871 of an SV instead of a string/length pair.
872
873 =cut
874 */
875
876 GV *
877 Perl_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
891 Exactly like L</gv_fetchmeth_pvn_autoload>, but takes a nul-terminated string
892 instead of a string/length pair.
893
894 =cut
895 */
896
897 GV *
898 Perl_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
907 Same as C<gv_fetchmeth_pvn()>, but looks for autoloaded subroutines too.
908 Returns a glob for the subroutine.
909
910 For an autoloaded subroutine without a GV, will create a GV even
911 if C<level < 0>.  For an autoloaded subroutine without a stub, C<GvCV()>
912 of the result may be zero.
913
914 Currently, the only significant value for C<flags> is C<SVf_UTF8>.
915
916 =cut
917 */
918
919 GV *
920 Perl_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
954 Returns the glob which contains the subroutine to call to invoke the method
955 on the C<stash>.  In fact in the presence of autoloading this may be the
956 glob for "AUTOLOAD".  In this case the corresponding variable C<$AUTOLOAD> is
957 already setup.
958
959 The third parameter of C<gv_fetchmethod_autoload> determines whether
960 AUTOLOAD lookup is performed if the given method is not present: non-zero
961 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
962 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
963 with a non-zero C<autoload> parameter.
964
965 These functions grant C<"SUPER"> token
966 as a prefix of the method name.  Note
967 that if you want to keep the returned glob for a long time, you need to
968 check for it being "AUTOLOAD", since at the later time the call may load a
969 different subroutine due to C<$AUTOLOAD> changing its value.  Use the glob
970 created as a side effect to do this.
971
972 These functions have the same side-effects as C<gv_fetchmeth> with
973 C<level==0>.  The warning against passing the GV returned by
974 C<gv_fetchmeth> to C<call_sv> applies equally to these functions.
975
976 =cut
977 */
978
979 GV *
980 Perl_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
987 GV *
988 Perl_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
999 GV *
1000 Perl_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
1006 /* Don't merge this yet, as it's likely to get a len parameter, and possibly
1007    even a U32 hash */
1008 GV *
1009 Perl_gv_fetchmethod_pvn_flags(pTHX_ HV *stash, const char *name, const STRLEN len, U32 flags)
1010 {
1011     const char *nend;
1012     const char *nsplit = NULL;
1013     GV* gv;
1014     HV* ostash = stash;
1015     const char * const origname = name;
1016     SV *const error_report = MUTABLE_SV(stash);
1017     const U32 autoload = flags & GV_AUTOLOAD;
1018     const U32 do_croak = flags & GV_CROAK;
1019     const U32 is_utf8  = flags & SVf_UTF8;
1020
1021     PERL_ARGS_ASSERT_GV_FETCHMETHOD_PVN_FLAGS;
1022
1023     if (SvTYPE(stash) < SVt_PVHV)
1024         stash = NULL;
1025     else {
1026         /* The only way stash can become NULL later on is if nsplit is set,
1027            which in turn means that there is no need for a SVt_PVHV case
1028            the error reporting code.  */
1029     }
1030
1031     for (nend = name; *nend || nend != (origname + len); nend++) {
1032         if (*nend == '\'') {
1033             nsplit = nend;
1034             name = nend + 1;
1035         }
1036         else if (*nend == ':' && *(nend + 1) == ':') {
1037             nsplit = nend++;
1038             name = nend + 1;
1039         }
1040     }
1041     if (nsplit) {
1042         if ((nsplit - origname) == 5 && memEQ(origname, "SUPER", 5)) {
1043             /* ->SUPER::method should really be looked up in original stash */
1044             stash = CopSTASH(PL_curcop);
1045             flags |= GV_SUPER;
1046             DEBUG_o( Perl_deb(aTHX_ "Treating %s as %s::%s\n",
1047                          origname, HvENAME_get(stash), name) );
1048         }
1049         else if ((nsplit - origname) >= 7 &&
1050                  strnEQ(nsplit - 7, "::SUPER", 7)) {
1051             /* don't autovifify if ->NoSuchStash::SUPER::method */
1052             stash = gv_stashpvn(origname, nsplit - origname - 7, is_utf8);
1053             if (stash) flags |= GV_SUPER;
1054         }
1055         else {
1056             /* don't autovifify if ->NoSuchStash::method */
1057             stash = gv_stashpvn(origname, nsplit - origname, is_utf8);
1058         }
1059         ostash = stash;
1060     }
1061
1062     gv = gv_fetchmeth_pvn(stash, name, nend - name, 0, flags);
1063     if (!gv) {
1064         /* This is the special case that exempts Foo->import and
1065            Foo->unimport from being an error even if there's no
1066           import/unimport subroutine */
1067         if (strEQ(name,"import") || strEQ(name,"unimport"))
1068             gv = MUTABLE_GV(&PL_sv_yes);
1069         else if (autoload)
1070             gv = gv_autoload_pvn(
1071                 ostash, name, nend - name, GV_AUTOLOAD_ISMETHOD|flags
1072             );
1073         if (!gv && do_croak) {
1074             /* Right now this is exclusively for the benefit of S_method_common
1075                in pp_hot.c  */
1076             if (stash) {
1077                 /* If we can't find an IO::File method, it might be a call on
1078                  * a filehandle. If IO:File has not been loaded, try to
1079                  * require it first instead of croaking */
1080                 const char *stash_name = HvNAME_get(stash);
1081                 if (stash_name && memEQs(stash_name, HvNAMELEN_get(stash), "IO::File")
1082                     && !Perl_hv_common(aTHX_ GvHVn(PL_incgv), NULL,
1083                                        STR_WITH_LEN("IO/File.pm"), 0,
1084                                        HV_FETCH_ISEXISTS, NULL, 0)
1085                 ) {
1086                     require_pv("IO/File.pm");
1087                     gv = gv_fetchmeth_pvn(stash, name, nend - name, 0, flags);
1088                     if (gv)
1089                         return gv;
1090                 }
1091                 Perl_croak(aTHX_
1092                            "Can't locate object method \"%"UTF8f
1093                            "\" via package \"%"HEKf"\"",
1094                                     UTF8fARG(is_utf8, nend - name, name),
1095                                     HEKfARG(HvNAME_HEK(stash)));
1096             }
1097             else {
1098                 SV* packnamesv;
1099
1100                 if (nsplit) {
1101                     packnamesv = newSVpvn_flags(origname, nsplit - origname,
1102                                                     SVs_TEMP | is_utf8);
1103                 } else {
1104                     packnamesv = error_report;
1105                 }
1106
1107                 Perl_croak(aTHX_
1108                            "Can't locate object method \"%"UTF8f
1109                            "\" via package \"%"SVf"\""
1110                            " (perhaps you forgot to load \"%"SVf"\"?)",
1111                            UTF8fARG(is_utf8, nend - name, name),
1112                            SVfARG(packnamesv), SVfARG(packnamesv));
1113             }
1114         }
1115     }
1116     else if (autoload) {
1117         CV* const cv = GvCV(gv);
1118         if (!CvROOT(cv) && !CvXSUB(cv)) {
1119             GV* stubgv;
1120             GV* autogv;
1121
1122             if (CvANON(cv) || CvLEXICAL(cv))
1123                 stubgv = gv;
1124             else {
1125                 stubgv = CvGV(cv);
1126                 if (GvCV(stubgv) != cv)         /* orphaned import */
1127                     stubgv = gv;
1128             }
1129             autogv = gv_autoload_pvn(GvSTASH(stubgv),
1130                                   GvNAME(stubgv), GvNAMELEN(stubgv),
1131                                   GV_AUTOLOAD_ISMETHOD
1132                                    | (GvNAMEUTF8(stubgv) ? SVf_UTF8 : 0));
1133             if (autogv)
1134                 gv = autogv;
1135         }
1136     }
1137
1138     return gv;
1139 }
1140
1141 GV*
1142 Perl_gv_autoload_sv(pTHX_ HV *stash, SV* namesv, U32 flags)
1143 {
1144    char *namepv;
1145    STRLEN namelen;
1146    PERL_ARGS_ASSERT_GV_AUTOLOAD_SV;
1147    namepv = SvPV(namesv, namelen);
1148    if (SvUTF8(namesv))
1149        flags |= SVf_UTF8;
1150    return gv_autoload_pvn(stash, namepv, namelen, flags);
1151 }
1152
1153 GV*
1154 Perl_gv_autoload_pv(pTHX_ HV *stash, const char *namepv, U32 flags)
1155 {
1156    PERL_ARGS_ASSERT_GV_AUTOLOAD_PV;
1157    return gv_autoload_pvn(stash, namepv, strlen(namepv), flags);
1158 }
1159
1160 GV*
1161 Perl_gv_autoload_pvn(pTHX_ HV *stash, const char *name, STRLEN len, U32 flags)
1162 {
1163     GV* gv;
1164     CV* cv;
1165     HV* varstash;
1166     GV* vargv;
1167     SV* varsv;
1168     SV *packname = NULL;
1169     U32 is_utf8 = flags & SVf_UTF8 ? SVf_UTF8 : 0;
1170
1171     PERL_ARGS_ASSERT_GV_AUTOLOAD_PVN;
1172
1173     if (len == S_autolen && memEQ(name, S_autoload, S_autolen))
1174         return NULL;
1175     if (stash) {
1176         if (SvTYPE(stash) < SVt_PVHV) {
1177             STRLEN packname_len = 0;
1178             const char * const packname_ptr = SvPV_const(MUTABLE_SV(stash), packname_len);
1179             packname = newSVpvn_flags(packname_ptr, packname_len,
1180                                       SVs_TEMP | SvUTF8(stash));
1181             stash = NULL;
1182         }
1183         else
1184             packname = sv_2mortal(newSVhek(HvNAME_HEK(stash)));
1185         if (flags & GV_SUPER) sv_catpvs(packname, "::SUPER");
1186     }
1187     if (!(gv = gv_fetchmeth_pvn(stash, S_autoload, S_autolen, FALSE,
1188                                 is_utf8 | (flags & GV_SUPER))))
1189         return NULL;
1190     cv = GvCV(gv);
1191
1192     if (!(CvROOT(cv) || CvXSUB(cv)))
1193         return NULL;
1194
1195     /*
1196      * Inheriting AUTOLOAD for non-methods works ... for now.
1197      */
1198     if (
1199         !(flags & GV_AUTOLOAD_ISMETHOD)
1200      && (GvCVGEN(gv) || GvSTASH(gv) != stash)
1201     )
1202         Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED),
1203                          "Use of inherited AUTOLOAD for non-method %"SVf
1204                          "::%"UTF8f"() is deprecated",
1205                          SVfARG(packname),
1206                          UTF8fARG(is_utf8, len, name));
1207
1208     if (CvISXSUB(cv)) {
1209         /* Instead of forcing the XSUB do another lookup for $AUTOLOAD
1210          * and split that value on the last '::', pass along the same data
1211          * via the SvPVX field in the CV, and the stash in CvSTASH.
1212          *
1213          * Due to an unfortunate accident of history, the SvPVX field
1214          * serves two purposes.  It is also used for the subroutine's pro-
1215          * type.  Since SvPVX has been documented as returning the sub name
1216          * for a long time, but not as returning the prototype, we have
1217          * to preserve the SvPVX AUTOLOAD behaviour and put the prototype
1218          * elsewhere.
1219          *
1220          * We put the prototype in the same allocated buffer, but after
1221          * the sub name.  The SvPOK flag indicates the presence of a proto-
1222          * type.  The CvAUTOLOAD flag indicates the presence of a sub name.
1223          * If both flags are on, then SvLEN is used to indicate the end of
1224          * the prototype (artificially lower than what is actually allo-
1225          * cated), at the risk of having to reallocate a few bytes unneces-
1226          * sarily--but that should happen very rarely, if ever.
1227          *
1228          * We use SvUTF8 for both prototypes and sub names, so if one is
1229          * UTF8, the other must be upgraded.
1230          */
1231         CvSTASH_set(cv, stash);
1232         if (SvPOK(cv)) { /* Ouch! */
1233             SV * const tmpsv = newSVpvn_flags(name, len, is_utf8);
1234             STRLEN ulen;
1235             const char *proto = CvPROTO(cv);
1236             assert(proto);
1237             if (SvUTF8(cv))
1238                 sv_utf8_upgrade_flags_grow(tmpsv, 0, CvPROTOLEN(cv) + 2);
1239             ulen = SvCUR(tmpsv);
1240             SvCUR(tmpsv)++; /* include null in string */
1241             sv_catpvn_flags(
1242                 tmpsv, proto, CvPROTOLEN(cv), SV_CATBYTES*!SvUTF8(cv)
1243             );
1244             SvTEMP_on(tmpsv); /* Allow theft */
1245             sv_setsv_nomg((SV *)cv, tmpsv);
1246             SvTEMP_off(tmpsv);
1247             SvREFCNT_dec_NN(tmpsv);
1248             SvLEN(cv) = SvCUR(cv) + 1;
1249             SvCUR(cv) = ulen;
1250         }
1251         else {
1252           sv_setpvn((SV *)cv, name, len);
1253           SvPOK_off(cv);
1254           if (is_utf8)
1255             SvUTF8_on(cv);
1256           else SvUTF8_off(cv);
1257         }
1258         CvAUTOLOAD_on(cv);
1259     }
1260
1261     /*
1262      * Given &FOO::AUTOLOAD, set $FOO::AUTOLOAD to desired function name.
1263      * The subroutine's original name may not be "AUTOLOAD", so we don't
1264      * use that, but for lack of anything better we will use the sub's
1265      * original package to look up $AUTOLOAD.
1266      */
1267     varstash = CvNAMED(cv) ? CvSTASH(cv) : GvSTASH(CvGV(cv));
1268     vargv = *(GV**)hv_fetch(varstash, S_autoload, S_autolen, TRUE);
1269     ENTER;
1270
1271     if (!isGV(vargv)) {
1272         gv_init_pvn(vargv, varstash, S_autoload, S_autolen, 0);
1273 #ifdef PERL_DONT_CREATE_GVSV
1274         GvSV(vargv) = newSV(0);
1275 #endif
1276     }
1277     LEAVE;
1278     varsv = GvSVn(vargv);
1279     SvTAINTED_off(varsv); /* previous $AUTOLOAD taint is obsolete */
1280     /* XXX: this process is not careful to avoid extra magic gets and sets; tied $AUTOLOAD will get noise */
1281     sv_setsv(varsv, packname);
1282     sv_catpvs(varsv, "::");
1283     /* Ensure SvSETMAGIC() is called if necessary. In particular, to clear
1284        tainting if $FOO::AUTOLOAD was previously tainted, but is not now.  */
1285     sv_catpvn_flags(
1286         varsv, name, len,
1287         SV_SMAGIC|(is_utf8 ? SV_CATUTF8 : SV_CATBYTES)
1288     );
1289     if (is_utf8)
1290         SvUTF8_on(varsv);
1291     return gv;
1292 }
1293
1294
1295 /* require_tie_mod() internal routine for requiring a module
1296  * that implements the logic of automatic ties like %! and %-
1297  * It loads the module and then calls the _tie_it subroutine
1298  * with the passed gv as an argument.
1299  *
1300  * The "gv" parameter should be the glob.
1301  * "varpv" holds the name of the var, used for error messages.
1302  * "namesv" holds the module name. Its refcount will be decremented.
1303  * "flags": if flag & 1 then save the scalar before loading.
1304  * For the protection of $! to work (it is set by this routine)
1305  * the sv slot must already be magicalized.
1306  */
1307 STATIC void
1308 S_require_tie_mod(pTHX_ GV *gv, const char *varpv, const char * name,
1309                         STRLEN len, const U32 flags)
1310 {
1311     const char varname = *varpv; /* varpv might be clobbered by
1312                                     load_module, so save it.  For the
1313                                     moment it’s always a single char.  */
1314     const SV * const target = varname == '[' ? GvSV(gv) : (SV *)GvHV(gv);
1315     SV * const namesv = newSVpvn(name, len);
1316
1317     PERL_ARGS_ASSERT_REQUIRE_TIE_MOD;
1318
1319     /* If it is not tied */
1320     if (!target || !SvRMAGICAL(target)
1321      || !mg_find(target,
1322                  varname == '[' ? PERL_MAGIC_tiedscalar : PERL_MAGIC_tied))
1323     {
1324       HV *stash;
1325       GV **gvp;
1326       dSP;
1327
1328       ENTER;
1329       SAVEFREESV(namesv);
1330
1331 #define HV_FETCH_TIE_FUNC (GV **)hv_fetch(stash, "_tie_it", 7, 0)
1332
1333       /* Load the module if it is not loaded.  */
1334       if (!(stash = gv_stashsv(namesv, 0))
1335        || !(gvp = HV_FETCH_TIE_FUNC) || !*gvp || !GvCV(*gvp))
1336       {
1337         SV *module = newSVsv(namesv);
1338         const char type = varname == '[' ? '$' : '%';
1339         if ( flags & 1 )
1340             save_scalar(gv);
1341         Perl_load_module(aTHX_ PERL_LOADMOD_NOIMPORT, module, NULL);
1342         assert(sp == PL_stack_sp);
1343         stash = gv_stashsv(namesv, 0);
1344         if (!stash)
1345             Perl_croak(aTHX_ "panic: Can't use %c%c because %"SVf" is not available",
1346                     type, varname, SVfARG(namesv));
1347         else if (!(gvp = HV_FETCH_TIE_FUNC) || !*gvp || !GvCV(*gvp))
1348             Perl_croak(aTHX_ "panic: Can't use %c%c because %"SVf" does not define _tie_it",
1349                     type, varname, SVfARG(namesv));
1350       }
1351       /* Now call the tie function.  It should be in *gvp.  */
1352       assert(gvp); assert(*gvp); assert(GvCV(*gvp));
1353       PUSHMARK(SP);
1354       XPUSHs((SV *)gv);
1355       PUTBACK;
1356       call_sv((SV *)*gvp, G_VOID|G_DISCARD);
1357       LEAVE;
1358     }
1359     else SvREFCNT_dec_NN(namesv);
1360 }
1361
1362 /*
1363 =for apidoc gv_stashpv
1364
1365 Returns a pointer to the stash for a specified package.  Uses C<strlen> to
1366 determine the length of C<name>, then calls C<gv_stashpvn()>.
1367
1368 =cut
1369 */
1370
1371 HV*
1372 Perl_gv_stashpv(pTHX_ const char *name, I32 create)
1373 {
1374     PERL_ARGS_ASSERT_GV_STASHPV;
1375     return gv_stashpvn(name, strlen(name), create);
1376 }
1377
1378 /*
1379 =for apidoc gv_stashpvn
1380
1381 Returns a pointer to the stash for a specified package.  The C<namelen>
1382 parameter indicates the length of the C<name>, in bytes.  C<flags> is passed
1383 to C<gv_fetchpvn_flags()>, so if set to C<GV_ADD> then the package will be
1384 created if it does not already exist.  If the package does not exist and
1385 C<flags> is 0 (or any other setting that does not create packages) then C<NULL>
1386 is returned.
1387
1388 Flags may be one of:
1389
1390     GV_ADD
1391     SVf_UTF8
1392     GV_NOADD_NOINIT
1393     GV_NOINIT
1394     GV_NOEXPAND
1395     GV_ADDMG
1396
1397 The most important of which are probably C<GV_ADD> and C<SVf_UTF8>.
1398
1399 Note, use of C<gv_stashsv> instead of C<gv_stashpvn> where possible is strongly
1400 recommended for performance reasons.
1401
1402 =cut
1403 */
1404
1405 /*
1406 gv_stashpvn_internal
1407
1408 Perform the internal bits of gv_stashsvpvn_cached. You could think of this
1409 as being one half of the logic. Not to be called except from gv_stashsvpvn_cached().
1410
1411 */
1412
1413 PERL_STATIC_INLINE HV*
1414 S_gv_stashpvn_internal(pTHX_ const char *name, U32 namelen, I32 flags)
1415 {
1416     char smallbuf[128];
1417     char *tmpbuf;
1418     HV *stash;
1419     GV *tmpgv;
1420     U32 tmplen = namelen + 2;
1421
1422     PERL_ARGS_ASSERT_GV_STASHPVN_INTERNAL;
1423
1424     if (tmplen <= sizeof smallbuf)
1425         tmpbuf = smallbuf;
1426     else
1427         Newx(tmpbuf, tmplen, char);
1428     Copy(name, tmpbuf, namelen, char);
1429     tmpbuf[namelen]   = ':';
1430     tmpbuf[namelen+1] = ':';
1431     tmpgv = gv_fetchpvn_flags(tmpbuf, tmplen, flags, SVt_PVHV);
1432     if (tmpbuf != smallbuf)
1433         Safefree(tmpbuf);
1434     if (!tmpgv || !isGV_with_GP(tmpgv))
1435         return NULL;
1436     stash = GvHV(tmpgv);
1437     if (!(flags & ~GV_NOADD_MASK) && !stash) return NULL;
1438     assert(stash);
1439     if (!HvNAME_get(stash)) {
1440         hv_name_set(stash, name, namelen, flags & SVf_UTF8 ? SVf_UTF8 : 0 );
1441         
1442         /* FIXME: This is a repeat of logic in gv_fetchpvn_flags */
1443         /* If the containing stash has multiple effective
1444            names, see that this one gets them, too. */
1445         if (HvAUX(GvSTASH(tmpgv))->xhv_name_count)
1446             mro_package_moved(stash, NULL, tmpgv, 1);
1447     }
1448     return stash;
1449 }
1450
1451 /*
1452 gv_stashsvpvn_cached
1453
1454 Returns a pointer to the stash for a specified package, possibly
1455 cached.  Implements both C<gv_stashpvn> and C<gc_stashsv>.
1456
1457 Requires one of either namesv or namepv to be non-null.
1458
1459 See C<L</gv_stashpvn>> for details on "flags".
1460
1461 Note the sv interface is strongly preferred for performance reasons.
1462
1463 */
1464
1465 #define PERL_ARGS_ASSERT_GV_STASHSVPVN_CACHED \
1466     assert(namesv || name)
1467
1468 PERL_STATIC_INLINE HV*
1469 S_gv_stashsvpvn_cached(pTHX_ SV *namesv, const char *name, U32 namelen, I32 flags)
1470 {
1471     HV* stash;
1472     HE* he;
1473
1474     PERL_ARGS_ASSERT_GV_STASHSVPVN_CACHED;
1475
1476     he = (HE *)hv_common(
1477         PL_stashcache, namesv, name, namelen,
1478         (flags & SVf_UTF8) ? HVhek_UTF8 : 0, 0, NULL, 0
1479     );
1480
1481     if (he) return INT2PTR(HV*,SvIVX(HeVAL(he)));
1482     else if (flags & GV_CACHE_ONLY) return NULL;
1483
1484     if (namesv) {
1485         if (SvOK(namesv)) { /* prevent double uninit warning */
1486             STRLEN len;
1487             name = SvPV_const(namesv, len);
1488             namelen = len;
1489             flags |= SvUTF8(namesv);
1490         } else {
1491             name = ""; namelen = 0;
1492         }
1493     }
1494     stash = gv_stashpvn_internal(name, namelen, flags);
1495
1496     if (stash && namelen) {
1497         SV* const ref = newSViv(PTR2IV(stash));
1498         (void)hv_store(PL_stashcache, name,
1499             (flags & SVf_UTF8) ? -(I32)namelen : (I32)namelen, ref, 0);
1500     }
1501
1502     return stash;
1503 }
1504
1505 HV*
1506 Perl_gv_stashpvn(pTHX_ const char *name, U32 namelen, I32 flags)
1507 {
1508     PERL_ARGS_ASSERT_GV_STASHPVN;
1509     return gv_stashsvpvn_cached(NULL, name, namelen, flags);
1510 }
1511
1512 /*
1513 =for apidoc gv_stashsv
1514
1515 Returns a pointer to the stash for a specified package.  See
1516 C<L</gv_stashpvn>>.
1517
1518 Note this interface is strongly preferred over C<gv_stashpvn> for performance
1519 reasons.
1520
1521 =cut
1522 */
1523
1524 HV*
1525 Perl_gv_stashsv(pTHX_ SV *sv, I32 flags)
1526 {
1527     PERL_ARGS_ASSERT_GV_STASHSV;
1528     return gv_stashsvpvn_cached(sv, NULL, 0, flags);
1529 }
1530
1531
1532 GV *
1533 Perl_gv_fetchpv(pTHX_ const char *nambeg, I32 add, const svtype sv_type) {
1534     PERL_ARGS_ASSERT_GV_FETCHPV;
1535     return gv_fetchpvn_flags(nambeg, strlen(nambeg), add, sv_type);
1536 }
1537
1538 GV *
1539 Perl_gv_fetchsv(pTHX_ SV *name, I32 flags, const svtype sv_type) {
1540     STRLEN len;
1541     const char * const nambeg =
1542        SvPV_flags_const(name, len, flags & GV_NO_SVGMAGIC ? 0 : SV_GMAGIC);
1543     PERL_ARGS_ASSERT_GV_FETCHSV;
1544     return gv_fetchpvn_flags(nambeg, len, flags | SvUTF8(name), sv_type);
1545 }
1546
1547 PERL_STATIC_INLINE void
1548 S_gv_magicalize_isa(pTHX_ GV *gv)
1549 {
1550     AV* av;
1551
1552     PERL_ARGS_ASSERT_GV_MAGICALIZE_ISA;
1553
1554     av = GvAVn(gv);
1555     GvMULTI_on(gv);
1556     sv_magic(MUTABLE_SV(av), MUTABLE_SV(gv), PERL_MAGIC_isa,
1557              NULL, 0);
1558 }
1559
1560 /* This function grabs name and tries to split a stash and glob
1561  * from its contents. TODO better description, comments
1562  * 
1563  * If the function returns TRUE and 'name == name_end', then
1564  * 'gv' can be directly returned to the caller of gv_fetchpvn_flags
1565  */
1566 PERL_STATIC_INLINE bool
1567 S_parse_gv_stash_name(pTHX_ HV **stash, GV **gv, const char **name,
1568                STRLEN *len, const char *nambeg, STRLEN full_len,
1569                const U32 is_utf8, const I32 add)
1570 {
1571     const char *name_cursor;
1572     const char *const name_end = nambeg + full_len;
1573     const char *const name_em1 = name_end - 1;
1574
1575     PERL_ARGS_ASSERT_PARSE_GV_STASH_NAME;
1576     
1577     if (full_len > 2 && **name == '*' && isIDFIRST_lazy_if(*name + 1, is_utf8)) {
1578         /* accidental stringify on a GV? */
1579         (*name)++;
1580     }
1581
1582     for (name_cursor = *name; name_cursor < name_end; name_cursor++) {
1583         if (name_cursor < name_em1 &&
1584             ((*name_cursor == ':' && name_cursor[1] == ':')
1585            || *name_cursor == '\''))
1586         {
1587             if (!*stash)
1588                 *stash = PL_defstash;
1589             if (!*stash || !SvREFCNT(*stash)) /* symbol table under destruction */
1590                 return FALSE;
1591
1592             *len = name_cursor - *name;
1593             if (name_cursor > nambeg) { /* Skip for initial :: or ' */
1594                 const char *key;
1595                 GV**gvp;
1596                 if (*name_cursor == ':') {
1597                     key = *name;
1598                     *len += 2;
1599                 }
1600                 else {
1601                     char *tmpbuf;
1602                     Newx(tmpbuf, *len+2, char);
1603                     Copy(*name, tmpbuf, *len, char);
1604                     tmpbuf[(*len)++] = ':';
1605                     tmpbuf[(*len)++] = ':';
1606                     key = tmpbuf;
1607                 }
1608                 gvp = (GV**)hv_fetch(*stash, key, is_utf8 ? -((I32)*len) : (I32)*len, add);
1609                 *gv = gvp ? *gvp : NULL;
1610                 if (*gv && *gv != (const GV *)&PL_sv_undef) {
1611                     if (SvTYPE(*gv) != SVt_PVGV)
1612                         gv_init_pvn(*gv, *stash, key, *len, (add & GV_ADDMULTI)|is_utf8);
1613                     else
1614                         GvMULTI_on(*gv);
1615                 }
1616                 if (key != *name)
1617                     Safefree(key);
1618                 if (!*gv || *gv == (const GV *)&PL_sv_undef)
1619                     return FALSE;
1620
1621                 if (!(*stash = GvHV(*gv))) {
1622                     *stash = GvHV(*gv) = newHV();
1623                     if (!HvNAME_get(*stash)) {
1624                         if (GvSTASH(*gv) == PL_defstash && *len == 6
1625                             && strnEQ(*name, "CORE", 4))
1626                             hv_name_set(*stash, "CORE", 4, 0);
1627                         else
1628                             hv_name_set(
1629                                 *stash, nambeg, name_cursor-nambeg, is_utf8
1630                             );
1631                     /* If the containing stash has multiple effective
1632                     names, see that this one gets them, too. */
1633                     if (HvAUX(GvSTASH(*gv))->xhv_name_count)
1634                         mro_package_moved(*stash, NULL, *gv, 1);
1635                     }
1636                 }
1637                 else if (!HvNAME_get(*stash))
1638                     hv_name_set(*stash, nambeg, name_cursor - nambeg, is_utf8);
1639             }
1640
1641             if (*name_cursor == ':')
1642                 name_cursor++;
1643             *name = name_cursor+1;
1644             if (*name == name_end) {
1645                 if (!*gv)
1646                     *gv = MUTABLE_GV(*hv_fetchs(PL_defstash, "main::", TRUE));
1647                 return TRUE;
1648             }
1649         }
1650     }
1651     *len = name_cursor - *name;
1652     return TRUE;
1653 }
1654
1655 /* Checks if an unqualified name is in the main stash */
1656 PERL_STATIC_INLINE bool
1657 S_gv_is_in_main(pTHX_ const char *name, STRLEN len, const U32 is_utf8)
1658 {
1659     PERL_ARGS_ASSERT_GV_IS_IN_MAIN;
1660     
1661     /* If it's an alphanumeric variable */
1662     if ( len && isIDFIRST_lazy_if(name, is_utf8) ) {
1663         /* Some "normal" variables are always in main::,
1664          * like INC or STDOUT.
1665          */
1666         switch (len) {
1667             case 1:
1668             if (*name == '_')
1669                 return TRUE;
1670             break;
1671             case 3:
1672             if ((name[0] == 'I' && name[1] == 'N' && name[2] == 'C')
1673                 || (name[0] == 'E' && name[1] == 'N' && name[2] == 'V')
1674                 || (name[0] == 'S' && name[1] == 'I' && name[2] == 'G'))
1675                 return TRUE;
1676             break;
1677             case 4:
1678             if (name[0] == 'A' && name[1] == 'R' && name[2] == 'G'
1679                 && name[3] == 'V')
1680                 return TRUE;
1681             break;
1682             case 5:
1683             if (name[0] == 'S' && name[1] == 'T' && name[2] == 'D'
1684                 && name[3] == 'I' && name[4] == 'N')
1685                 return TRUE;
1686             break;
1687             case 6:
1688             if ((name[0] == 'S' && name[1] == 'T' && name[2] == 'D')
1689                 &&((name[3] == 'O' && name[4] == 'U' && name[5] == 'T')
1690                     ||(name[3] == 'E' && name[4] == 'R' && name[5] == 'R')))
1691                 return TRUE;
1692             break;
1693             case 7:
1694             if (name[0] == 'A' && name[1] == 'R' && name[2] == 'G'
1695                 && name[3] == 'V' && name[4] == 'O' && name[5] == 'U'
1696                 && name[6] == 'T')
1697                 return TRUE;
1698             break;
1699         }
1700     }
1701     /* *{""}, or a special variable like $@ */
1702     else
1703         return TRUE;
1704     
1705     return FALSE;
1706 }
1707
1708
1709 /* This function is called if parse_gv_stash_name() failed to
1710  * find a stash, or if GV_NOTQUAL or an empty name was passed
1711  * to gv_fetchpvn_flags.
1712  * 
1713  * It returns FALSE if the default stash can't be found nor created,
1714  * which might happen during global destruction.
1715  */
1716 PERL_STATIC_INLINE bool
1717 S_find_default_stash(pTHX_ HV **stash, const char *name, STRLEN len,
1718                const U32 is_utf8, const I32 add,
1719                const svtype sv_type)
1720 {
1721     PERL_ARGS_ASSERT_FIND_DEFAULT_STASH;
1722     
1723     /* No stash in name, so see how we can default */
1724
1725     if ( gv_is_in_main(name, len, is_utf8) ) {
1726         *stash = PL_defstash;
1727     }
1728     else {
1729         if (IN_PERL_COMPILETIME) {
1730             *stash = PL_curstash;
1731             if (add && (PL_hints & HINT_STRICT_VARS) &&
1732                 sv_type != SVt_PVCV &&
1733                 sv_type != SVt_PVGV &&
1734                 sv_type != SVt_PVFM &&
1735                 sv_type != SVt_PVIO &&
1736                 !(len == 1 && sv_type == SVt_PV &&
1737                 (*name == 'a' || *name == 'b')) )
1738             {
1739                 GV**gvp = (GV**)hv_fetch(*stash,name,is_utf8 ? -(I32)len : (I32)len,0);
1740                 if (!gvp || *gvp == (const GV *)&PL_sv_undef ||
1741                     SvTYPE(*gvp) != SVt_PVGV)
1742                 {
1743                     *stash = NULL;
1744                 }
1745                 else if ((sv_type == SVt_PV   && !GvIMPORTED_SV(*gvp)) ||
1746                          (sv_type == SVt_PVAV && !GvIMPORTED_AV(*gvp)) ||
1747                          (sv_type == SVt_PVHV && !GvIMPORTED_HV(*gvp)) )
1748                 {
1749                     /* diag_listed_as: Variable "%s" is not imported%s */
1750                     Perl_ck_warner_d(
1751                         aTHX_ packWARN(WARN_MISC),
1752                         "Variable \"%c%"UTF8f"\" is not imported",
1753                         sv_type == SVt_PVAV ? '@' :
1754                         sv_type == SVt_PVHV ? '%' : '$',
1755                         UTF8fARG(is_utf8, len, name));
1756                     if (GvCVu(*gvp))
1757                         Perl_ck_warner_d(
1758                             aTHX_ packWARN(WARN_MISC),
1759                             "\t(Did you mean &%"UTF8f" instead?)\n",
1760                             UTF8fARG(is_utf8, len, name)
1761                         );
1762                     *stash = NULL;
1763                 }
1764             }
1765         }
1766         else {
1767             /* Use the current op's stash */
1768             *stash = CopSTASH(PL_curcop);
1769         }
1770     }
1771
1772     if (!*stash) {
1773         if (add && !PL_in_clean_all) {
1774             GV *gv;
1775             qerror(Perl_mess(aTHX_
1776                  "Global symbol \"%s%"UTF8f
1777                  "\" requires explicit package name (did you forget to "
1778                  "declare \"my %s%"UTF8f"\"?)",
1779                  (sv_type == SVt_PV ? "$"
1780                   : sv_type == SVt_PVAV ? "@"
1781                   : sv_type == SVt_PVHV ? "%"
1782                   : ""), UTF8fARG(is_utf8, len, name),
1783                  (sv_type == SVt_PV ? "$"
1784                   : sv_type == SVt_PVAV ? "@"
1785                   : sv_type == SVt_PVHV ? "%"
1786                   : ""), UTF8fARG(is_utf8, len, name)));
1787             /* To maintain the output of errors after the strict exception
1788              * above, and to keep compat with older releases, rather than
1789              * placing the variables in the pad, we place
1790              * them in the <none>:: stash.
1791              */
1792             gv = gv_fetchpvs("<none>::", GV_ADDMULTI, SVt_PVHV);
1793             if (!gv) {
1794                 /* symbol table under destruction */
1795                 return FALSE;
1796             }
1797             *stash = GvHV(gv);
1798         }
1799         else
1800             return FALSE;
1801     }
1802
1803     if (!SvREFCNT(*stash))   /* symbol table under destruction */
1804         return FALSE;
1805
1806     return TRUE;
1807 }
1808
1809 /* gv_magicalize only turns on the SVf_READONLY flag, not SVf_PROTECT.  So
1810    redefine SvREADONLY_on for that purpose.  We don’t use it later on in
1811    this file.  */
1812 #undef SvREADONLY_on
1813 #define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
1814
1815 /* gv_magicalize() is called by gv_fetchpvn_flags when creating
1816  * a new GV.
1817  * Note that it does not insert the GV into the stash prior to
1818  * magicalization, which some variables require need in order
1819  * to work (like $[, %+, %-, %!), so callers must take care of
1820  * that beforehand.
1821  * 
1822  * The return value has a specific meaning for gv_fetchpvn_flags:
1823  * If it returns true, and the gv is empty, it indicates that its
1824  * refcount should be decreased.
1825  */
1826 PERL_STATIC_INLINE bool
1827 S_gv_magicalize(pTHX_ GV *gv, HV *stash, const char *name, STRLEN len,
1828                bool addmg, const svtype sv_type)
1829 {
1830     SSize_t paren;
1831
1832     PERL_ARGS_ASSERT_GV_MAGICALIZE;
1833     
1834     if (stash != PL_defstash) { /* not the main stash */
1835         /* We only have to check for a few names here: a, b, EXPORT, ISA
1836            and VERSION. All the others apply only to the main stash or to
1837            CORE (which is checked right after this). */
1838         if (len) {
1839             const char * const name2 = name + 1;
1840             switch (*name) {
1841             case 'E':
1842                 if (strnEQ(name2, "XPORT", 5))
1843                     GvMULTI_on(gv);
1844                 break;
1845             case 'I':
1846                 if (strEQ(name2, "SA"))
1847                     gv_magicalize_isa(gv);
1848                 break;
1849             case 'V':
1850                 if (strEQ(name2, "ERSION"))
1851                     GvMULTI_on(gv);
1852                 break;
1853             case 'a':
1854                 if (stash == PL_debstash && len==4 && strEQ(name2,"rgs")) {
1855                     GvMULTI_on(gv_AVadd(gv));
1856                     break;
1857                 }
1858             case 'b':
1859                 if (len == 1 && sv_type == SVt_PV)
1860                     GvMULTI_on(gv);
1861                 /* FALLTHROUGH */
1862             default:
1863                 goto try_core;
1864             }
1865             return addmg;
1866         }
1867       try_core:
1868         if (len > 1 /* shortest is uc */ && HvNAMELEN_get(stash) == 4) {
1869           /* Avoid null warning: */
1870           const char * const stashname = HvNAME(stash); assert(stashname);
1871           if (strnEQ(stashname, "CORE", 4))
1872             S_maybe_add_coresub(aTHX_ 0, gv, name, len);
1873         }
1874     }
1875     else if (len > 1) {
1876 #ifndef EBCDIC
1877         if (*name > 'V' ) {
1878             NOOP;
1879             /* Nothing else to do.
1880                The compiler will probably turn the switch statement into a
1881                branch table. Make sure we avoid even that small overhead for
1882                the common case of lower case variable names.  (On EBCDIC
1883                platforms, we can't just do:
1884                  if (NATIVE_TO_ASCII(*name) > NATIVE_TO_ASCII('V') ) {
1885                because cases like '\027' in the switch statement below are
1886                C1 (non-ASCII) controls on those platforms, so the remapping
1887                would make them larger than 'V')
1888              */
1889         } else
1890 #endif
1891         {
1892             const char * name2 = name + 1;
1893             switch (*name) {
1894             case 'A':
1895                 if (strEQ(name2, "RGV")) {
1896                     IoFLAGS(GvIOn(gv)) |= IOf_ARGV|IOf_START;
1897                 }
1898                 else if (strEQ(name2, "RGVOUT")) {
1899                     GvMULTI_on(gv);
1900                 }
1901                 break;
1902             case 'E':
1903                 if (strnEQ(name2, "XPORT", 5))
1904                     GvMULTI_on(gv);
1905                 break;
1906             case 'I':
1907                 if (strEQ(name2, "SA")) {
1908                     gv_magicalize_isa(gv);
1909                 }
1910                 break;
1911             case 'S':
1912                 if (strEQ(name2, "IG")) {
1913                     HV *hv;
1914                     I32 i;
1915                     if (!PL_psig_name) {
1916                         Newxz(PL_psig_name, 2 * SIG_SIZE, SV*);
1917                         Newxz(PL_psig_pend, SIG_SIZE, int);
1918                         PL_psig_ptr = PL_psig_name + SIG_SIZE;
1919                     } else {
1920                         /* I think that the only way to get here is to re-use an
1921                            embedded perl interpreter, where the previous
1922                            use didn't clean up fully because
1923                            PL_perl_destruct_level was 0. I'm not sure that we
1924                            "support" that, in that I suspect in that scenario
1925                            there are sufficient other garbage values left in the
1926                            interpreter structure that something else will crash
1927                            before we get here. I suspect that this is one of
1928                            those "doctor, it hurts when I do this" bugs.  */
1929                         Zero(PL_psig_name, 2 * SIG_SIZE, SV*);
1930                         Zero(PL_psig_pend, SIG_SIZE, int);
1931                     }
1932                     GvMULTI_on(gv);
1933                     hv = GvHVn(gv);
1934                     hv_magic(hv, NULL, PERL_MAGIC_sig);
1935                     for (i = 1; i < SIG_SIZE; i++) {
1936                         SV * const * const init = hv_fetch(hv, PL_sig_name[i], strlen(PL_sig_name[i]), 1);
1937                         if (init)
1938                             sv_setsv(*init, &PL_sv_undef);
1939                     }
1940                 }
1941                 break;
1942             case 'V':
1943                 if (strEQ(name2, "ERSION"))
1944                     GvMULTI_on(gv);
1945                 break;
1946             case '\003':        /* $^CHILD_ERROR_NATIVE */
1947                 if (strEQ(name2, "HILD_ERROR_NATIVE"))
1948                     goto magicalize;
1949                 break;
1950             case '\005':        /* $^ENCODING */
1951                 if (strEQ(name2, "NCODING"))
1952                     goto magicalize;
1953                 break;
1954             case '\007':        /* $^GLOBAL_PHASE */
1955                 if (strEQ(name2, "LOBAL_PHASE"))
1956                     goto ro_magicalize;
1957                 break;
1958             case '\014':        /* $^LAST_FH */
1959                 if (strEQ(name2, "AST_FH"))
1960                     goto ro_magicalize;
1961                 break;
1962             case '\015':        /* $^MATCH */
1963                 if (strEQ(name2, "ATCH")) {
1964                     paren = RX_BUFF_IDX_CARET_FULLMATCH;
1965                     goto storeparen;
1966                 }
1967                 break;
1968             case '\017':        /* $^OPEN */
1969                 if (strEQ(name2, "PEN"))
1970                     goto magicalize;
1971                 break;
1972             case '\020':        /* $^PREMATCH  $^POSTMATCH */
1973                 if (strEQ(name2, "REMATCH")) {
1974                     paren = RX_BUFF_IDX_CARET_PREMATCH;
1975                     goto storeparen;
1976                 }
1977                 if (strEQ(name2, "OSTMATCH")) {
1978                     paren = RX_BUFF_IDX_CARET_POSTMATCH;
1979                     goto storeparen;
1980                 }
1981                 break;
1982             case '\024':        /* ${^TAINT} */
1983                 if (strEQ(name2, "AINT"))
1984                     goto ro_magicalize;
1985                 break;
1986             case '\025':        /* ${^UNICODE}, ${^UTF8LOCALE} */
1987                 if (strEQ(name2, "NICODE"))
1988                     goto ro_magicalize;
1989                 if (strEQ(name2, "TF8LOCALE"))
1990                     goto ro_magicalize;
1991                 if (strEQ(name2, "TF8CACHE"))
1992                     goto magicalize;
1993                 break;
1994             case '\027':        /* $^WARNING_BITS */
1995                 if (strEQ(name2, "ARNING_BITS"))
1996                     goto magicalize;
1997 #ifdef WIN32
1998                 else if (strEQ(name2, "IN32_SLOPPY_STAT"))
1999                     goto magicalize;
2000 #endif
2001                 break;
2002             case '1':
2003             case '2':
2004             case '3':
2005             case '4':
2006             case '5':
2007             case '6':
2008             case '7':
2009             case '8':
2010             case '9':
2011             {
2012                 /* Ensures that we have an all-digit variable, ${"1foo"} fails
2013                    this test  */
2014                 UV uv;
2015                 if (!grok_atoUV(name, &uv, NULL) || uv > I32_MAX)
2016                     return addmg;
2017                 /* XXX why are we using a SSize_t? */
2018                 paren = (SSize_t)(I32)uv;
2019                 goto storeparen;
2020             }
2021             }
2022         }
2023     } else {
2024         /* Names of length 1.  (Or 0. But name is NUL terminated, so that will
2025            be case '\0' in this switch statement (ie a default case)  */
2026         switch (*name) {
2027         case '&':               /* $& */
2028             paren = RX_BUFF_IDX_FULLMATCH;
2029             goto sawampersand;
2030         case '`':               /* $` */
2031             paren = RX_BUFF_IDX_PREMATCH;
2032             goto sawampersand;
2033         case '\'':              /* $' */
2034             paren = RX_BUFF_IDX_POSTMATCH;
2035         sawampersand:
2036 #ifdef PERL_SAWAMPERSAND
2037             if (!(
2038                 sv_type == SVt_PVAV ||
2039                 sv_type == SVt_PVHV ||
2040                 sv_type == SVt_PVCV ||
2041                 sv_type == SVt_PVFM ||
2042                 sv_type == SVt_PVIO
2043                 )) { PL_sawampersand |=
2044                         (*name == '`')
2045                             ? SAWAMPERSAND_LEFT
2046                             : (*name == '&')
2047                                 ? SAWAMPERSAND_MIDDLE
2048                                 : SAWAMPERSAND_RIGHT;
2049                 }
2050 #endif
2051             goto storeparen;
2052         case '1':               /* $1 */
2053         case '2':               /* $2 */
2054         case '3':               /* $3 */
2055         case '4':               /* $4 */
2056         case '5':               /* $5 */
2057         case '6':               /* $6 */
2058         case '7':               /* $7 */
2059         case '8':               /* $8 */
2060         case '9':               /* $9 */
2061             paren = *name - '0';
2062
2063         storeparen:
2064             /* Flag the capture variables with a NULL mg_ptr
2065                Use mg_len for the array index to lookup.  */
2066             sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, NULL, paren);
2067             break;
2068
2069         case ':':               /* $: */
2070             sv_setpv(GvSVn(gv),PL_chopset);
2071             goto magicalize;
2072
2073         case '?':               /* $? */
2074 #ifdef COMPLEX_STATUS
2075             SvUPGRADE(GvSVn(gv), SVt_PVLV);
2076 #endif
2077             goto magicalize;
2078
2079         case '!':               /* $! */
2080             GvMULTI_on(gv);
2081             /* If %! has been used, automatically load Errno.pm. */
2082
2083             sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
2084
2085             /* magicalization must be done before require_tie_mod is called */
2086             if (sv_type == SVt_PVHV || sv_type == SVt_PVGV)
2087                 require_tie_mod(gv, "!", "Errno", 5, 1);
2088
2089             break;
2090         case '-':               /* $- */
2091         case '+':               /* $+ */
2092         GvMULTI_on(gv); /* no used once warnings here */
2093         {
2094             AV* const av = GvAVn(gv);
2095             SV* const avc = (*name == '+') ? MUTABLE_SV(av) : NULL;
2096
2097             sv_magic(MUTABLE_SV(av), avc, PERL_MAGIC_regdata, NULL, 0);
2098             sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
2099             if (avc)
2100                 SvREADONLY_on(GvSVn(gv));
2101             SvREADONLY_on(av);
2102
2103             if (sv_type == SVt_PVHV || sv_type == SVt_PVGV)
2104                 require_tie_mod(gv, name, "Tie::Hash::NamedCapture",23, 0);
2105
2106             break;
2107         }
2108         case '*':               /* $* */
2109         case '#':               /* $# */
2110             if (sv_type == SVt_PV)
2111                 /* diag_listed_as: $* is no longer supported */
2112                 Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_SYNTAX),
2113                                  "$%c is no longer supported", *name);
2114             break;
2115         case '\010':    /* $^H */
2116             {
2117                 HV *const hv = GvHVn(gv);
2118                 hv_magic(hv, NULL, PERL_MAGIC_hints);
2119             }
2120             goto magicalize;
2121         case '[':               /* $[ */
2122             if ((sv_type == SVt_PV || sv_type == SVt_PVGV)
2123              && FEATURE_ARYBASE_IS_ENABLED) {
2124                 require_tie_mod(gv,name,"arybase",7,0);
2125             }
2126             else goto magicalize;
2127             break;
2128         case '\023':    /* $^S */
2129         ro_magicalize:
2130             SvREADONLY_on(GvSVn(gv));
2131             /* FALLTHROUGH */
2132         case '0':               /* $0 */
2133         case '^':               /* $^ */
2134         case '~':               /* $~ */
2135         case '=':               /* $= */
2136         case '%':               /* $% */
2137         case '.':               /* $. */
2138         case '(':               /* $( */
2139         case ')':               /* $) */
2140         case '<':               /* $< */
2141         case '>':               /* $> */
2142         case '\\':              /* $\ */
2143         case '/':               /* $/ */
2144         case '|':               /* $| */
2145         case '$':               /* $$ */
2146         case '\001':    /* $^A */
2147         case '\003':    /* $^C */
2148         case '\004':    /* $^D */
2149         case '\005':    /* $^E */
2150         case '\006':    /* $^F */
2151         case '\011':    /* $^I, NOT \t in EBCDIC */
2152         case '\016':    /* $^N */
2153         case '\017':    /* $^O */
2154         case '\020':    /* $^P */
2155         case '\024':    /* $^T */
2156         case '\027':    /* $^W */
2157         magicalize:
2158             sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
2159             break;
2160
2161         case '\014':    /* $^L */
2162             sv_setpvs(GvSVn(gv),"\f");
2163             break;
2164         case ';':               /* $; */
2165             sv_setpvs(GvSVn(gv),"\034");
2166             break;
2167         case ']':               /* $] */
2168         {
2169             SV * const sv = GvSV(gv);
2170             if (!sv_derived_from(PL_patchlevel, "version"))
2171                 upg_version(PL_patchlevel, TRUE);
2172             GvSV(gv) = vnumify(PL_patchlevel);
2173             SvREADONLY_on(GvSV(gv));
2174             SvREFCNT_dec(sv);
2175         }
2176         break;
2177         case '\026':    /* $^V */
2178         {
2179             SV * const sv = GvSV(gv);
2180             GvSV(gv) = new_version(PL_patchlevel);
2181             SvREADONLY_on(GvSV(gv));
2182             SvREFCNT_dec(sv);
2183         }
2184         break;
2185         case 'a':
2186         case 'b':
2187             if (sv_type == SVt_PV)
2188                 GvMULTI_on(gv);
2189         }
2190     }
2191
2192     return addmg;
2193 }
2194
2195 /* If we do ever start using this later on in the file, we need to make
2196    sure we don’t accidentally use the wrong definition.  */
2197 #undef SvREADONLY_on
2198
2199 /* This function is called when the stash already holds the GV of the magic
2200  * variable we're looking for, but we need to check that it has the correct
2201  * kind of magic.  For example, if someone first uses $! and then %!, the
2202  * latter would end up here, and we add the Errno tie to the HASH slot of
2203  * the *! glob.
2204  */
2205 PERL_STATIC_INLINE void
2206 S_maybe_multimagic_gv(pTHX_ GV *gv, const char *name, const svtype sv_type)
2207 {
2208     PERL_ARGS_ASSERT_MAYBE_MULTIMAGIC_GV;
2209
2210     if (sv_type == SVt_PVHV || sv_type == SVt_PVGV) {
2211         if (*name == '!')
2212             require_tie_mod(gv, "!", "Errno", 5, 1);
2213         else if (*name == '-' || *name == '+')
2214             require_tie_mod(gv, name, "Tie::Hash::NamedCapture", 23, 0);
2215     } else if (sv_type == SVt_PV) {
2216         if (*name == '*' || *name == '#') {
2217             /* diag_listed_as: $* is no longer supported */
2218             Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED,
2219                                              WARN_SYNTAX),
2220                              "$%c is no longer supported", *name);
2221         }
2222     }
2223     if (sv_type==SVt_PV || sv_type==SVt_PVGV) {
2224       switch (*name) {
2225       case '[':
2226           require_tie_mod(gv,name,"arybase",7,0);
2227           break;
2228 #ifdef PERL_SAWAMPERSAND
2229       case '`':
2230           PL_sawampersand |= SAWAMPERSAND_LEFT;
2231           (void)GvSVn(gv);
2232           break;
2233       case '&':
2234           PL_sawampersand |= SAWAMPERSAND_MIDDLE;
2235           (void)GvSVn(gv);
2236           break;
2237       case '\'':
2238           PL_sawampersand |= SAWAMPERSAND_RIGHT;
2239           (void)GvSVn(gv);
2240           break;
2241 #endif
2242       }
2243     }
2244 }
2245
2246 GV *
2247 Perl_gv_fetchpvn_flags(pTHX_ const char *nambeg, STRLEN full_len, I32 flags,
2248                        const svtype sv_type)
2249 {
2250     const char *name = nambeg;
2251     GV *gv = NULL;
2252     GV**gvp;
2253     STRLEN len;
2254     HV *stash = NULL;
2255     const I32 no_init = flags & (GV_NOADD_NOINIT | GV_NOINIT);
2256     const I32 no_expand = flags & GV_NOEXPAND;
2257     const I32 add = flags & ~GV_NOADD_MASK;
2258     const U32 is_utf8 = flags & SVf_UTF8;
2259     bool addmg = cBOOL(flags & GV_ADDMG);
2260     const char *const name_end = nambeg + full_len;
2261     U32 faking_it;
2262
2263     PERL_ARGS_ASSERT_GV_FETCHPVN_FLAGS;
2264
2265      /* If we have GV_NOTQUAL, the caller promised that
2266       * there is no stash, so we can skip the check.
2267       * Similarly if full_len is 0, since then we're
2268       * dealing with something like *{""} or ""->foo()
2269       */
2270     if ((flags & GV_NOTQUAL) || !full_len) {
2271         len = full_len;
2272     }
2273     else if (parse_gv_stash_name(&stash, &gv, &name, &len, nambeg, full_len, is_utf8, add)) {
2274         if (name == name_end) return gv;
2275     }
2276     else {
2277         return NULL;
2278     }
2279
2280     if (!stash && !find_default_stash(&stash, name, len, is_utf8, add, sv_type)) {
2281         return NULL;
2282     }
2283     
2284     /* By this point we should have a stash and a name */
2285     gvp = (GV**)hv_fetch(stash,name,is_utf8 ? -(I32)len : (I32)len,add);
2286     if (!gvp || *gvp == (const GV *)&PL_sv_undef) {
2287         if (addmg) gv = (GV *)newSV(0);
2288         else return NULL;
2289     }
2290     else gv = *gvp, addmg = 0;
2291     /* From this point on, addmg means gv has not been inserted in the
2292        symtab yet. */
2293
2294     if (SvTYPE(gv) == SVt_PVGV) {
2295         /* The GV already exists, so return it, but check if we need to do
2296          * anything else with it before that.
2297          */
2298         if (add) {
2299             /* This is the heuristic that handles if a variable triggers the
2300              * 'used only once' warning.  If there's already a GV in the stash
2301              * with this name, then we assume that the variable has been used
2302              * before and turn its MULTI flag on.
2303              * It's a heuristic because it can easily be "tricked", like with
2304              * BEGIN { $a = 1; $::{foo} = *a }; () = $foo
2305              * not warning about $main::foo being used just once
2306              */
2307             GvMULTI_on(gv);
2308             gv_init_svtype(gv, sv_type);
2309             /* You reach this path once the typeglob has already been created,
2310                either by the same or a different sigil.  If this path didn't
2311                exist, then (say) referencing $! first, and %! second would
2312                mean that %! was not handled correctly.  */
2313             if (len == 1 && stash == PL_defstash) {
2314                 maybe_multimagic_gv(gv, name, sv_type);
2315             }
2316             else if (len == 3 && sv_type == SVt_PVAV
2317                   && strnEQ(name, "ISA", 3)
2318                   && (!GvAV(gv) || !SvSMAGICAL(GvAV(gv))))
2319                 gv_magicalize_isa(gv);
2320         }
2321         return gv;
2322     } else if (no_init) {
2323         assert(!addmg);
2324         return gv;
2325     }
2326     /* If GV_NOEXPAND is true and what we got off the stash is a ref,
2327      * don't expand it to a glob. This is an optimization so that things
2328      * copying constants over, like Exporter, don't have to be rewritten
2329      * to take into account that you can store more than just globs in
2330      * stashes.
2331      */
2332     else if (no_expand && SvROK(gv)) {
2333         assert(!addmg);
2334         return gv;
2335     }
2336
2337     /* Adding a new symbol.
2338        Unless of course there was already something non-GV here, in which case
2339        we want to behave as if there was always a GV here, containing some sort
2340        of subroutine.
2341        Otherwise we run the risk of creating things like GvIO, which can cause
2342        subtle bugs. eg the one that tripped up SQL::Translator  */
2343
2344     faking_it = SvOK(gv);
2345
2346     if (add & GV_ADDWARN)
2347         Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
2348                 "Had to create %"UTF8f" unexpectedly",
2349                  UTF8fARG(is_utf8, name_end-nambeg, nambeg));
2350     gv_init_pvn(gv, stash, name, len, (add & GV_ADDMULTI)|is_utf8);
2351
2352     if ( isIDFIRST_lazy_if(name, is_utf8) && !ckWARN(WARN_ONCE) )
2353         GvMULTI_on(gv) ;
2354
2355 #define GvEMPTY(gv)      !(GvAV(gv) || GvHV(gv) || GvIO(gv) \
2356                         || GvCV(gv) || (GvSV(gv) && SvOK(GvSV(gv))))
2357     
2358     /* set up magic where warranted */
2359     if ( gv_magicalize(gv, stash, name, len, addmg, sv_type) ) {
2360         /* See 23496c6 */
2361         if (GvEMPTY(gv)) {
2362             if ( GvSV(gv) && SvMAGICAL(GvSV(gv)) ) {
2363                 /* The GV was and still is "empty", except that now
2364                  * it has the magic flags turned on, so we want it
2365                  * stored in the symtab.
2366                  */
2367                 (void)hv_store(stash,name,len,(SV *)gv,0);
2368             }
2369             else {
2370                 /* Most likely the temporary GV created above */
2371                 SvREFCNT_dec_NN(gv);
2372                 gv = NULL;
2373             }
2374         }
2375         else
2376             /* Not empty; this means gv_magicalize magicalised it.  */
2377             (void)hv_store(stash,name,len,(SV *)gv,0);
2378     }
2379     
2380     if (gv) gv_init_svtype(gv, faking_it ? SVt_PVCV : sv_type);
2381     return gv;
2382 }
2383
2384 void
2385 Perl_gv_fullname4(pTHX_ SV *sv, const GV *gv, const char *prefix, bool keepmain)
2386 {
2387     const char *name;
2388     const HV * const hv = GvSTASH(gv);
2389
2390     PERL_ARGS_ASSERT_GV_FULLNAME4;
2391
2392     sv_setpv(sv, prefix ? prefix : "");
2393
2394     if (hv && (name = HvNAME(hv))) {
2395       const STRLEN len = HvNAMELEN(hv);
2396       if (keepmain || strnNE(name, "main", len)) {
2397         sv_catpvn_flags(sv,name,len,HvNAMEUTF8(hv)?SV_CATUTF8:SV_CATBYTES);
2398         sv_catpvs(sv,"::");
2399       }
2400     }
2401     else sv_catpvs(sv,"__ANON__::");
2402     sv_catsv(sv,sv_2mortal(newSVhek(GvNAME_HEK(gv))));
2403 }
2404
2405 void
2406 Perl_gv_efullname4(pTHX_ SV *sv, const GV *gv, const char *prefix, bool keepmain)
2407 {
2408     const GV * const egv = GvEGVx(gv);
2409
2410     PERL_ARGS_ASSERT_GV_EFULLNAME4;
2411
2412     gv_fullname4(sv, egv ? egv : gv, prefix, keepmain);
2413 }
2414
2415
2416 /* recursively scan a stash and any nested stashes looking for entries
2417  * that need the "only used once" warning raised
2418  */
2419
2420 void
2421 Perl_gv_check(pTHX_ HV *stash)
2422 {
2423     I32 i;
2424
2425     PERL_ARGS_ASSERT_GV_CHECK;
2426
2427     if (!SvOOK(stash))
2428         return;
2429
2430     assert(HvARRAY(stash));
2431
2432     for (i = 0; i <= (I32) HvMAX(stash); i++) {
2433         const HE *entry;
2434         /* mark stash is being scanned, to avoid recursing */
2435         HvAUX(stash)->xhv_aux_flags |= HvAUXf_SCAN_STASH;
2436         for (entry = HvARRAY(stash)[i]; entry; entry = HeNEXT(entry)) {
2437             GV *gv;
2438             HV *hv;
2439             STRLEN keylen = HeKLEN(entry);
2440             const char * const key = HeKEY(entry);
2441
2442             if (keylen >= 2 && key[keylen-2] == ':'  && key[keylen-1] == ':' &&
2443                 (gv = MUTABLE_GV(HeVAL(entry))) && isGV(gv) && (hv = GvHV(gv)))
2444             {
2445                 if (hv != PL_defstash && hv != stash
2446                     && !(SvOOK(hv)
2447                         && (HvAUX(hv)->xhv_aux_flags & HvAUXf_SCAN_STASH))
2448                 )
2449                      gv_check(hv);              /* nested package */
2450             }
2451             else if ( *HeKEY(entry) != '_'
2452                         && isIDFIRST_lazy_if(HeKEY(entry), HeUTF8(entry)) ) {
2453                 const char *file;
2454                 gv = MUTABLE_GV(HeVAL(entry));
2455                 if (SvTYPE(gv) != SVt_PVGV || GvMULTI(gv))
2456                     continue;
2457                 file = GvFILE(gv);
2458                 CopLINE_set(PL_curcop, GvLINE(gv));
2459 #ifdef USE_ITHREADS
2460                 CopFILE(PL_curcop) = (char *)file;      /* set for warning */
2461 #else
2462                 CopFILEGV(PL_curcop)
2463                     = gv_fetchfile_flags(file, HEK_LEN(GvFILE_HEK(gv)), 0);
2464 #endif
2465                 Perl_warner(aTHX_ packWARN(WARN_ONCE),
2466                         "Name \"%"HEKf"::%"HEKf
2467                         "\" used only once: possible typo",
2468                             HEKfARG(HvNAME_HEK(stash)),
2469                             HEKfARG(GvNAME_HEK(gv)));
2470             }
2471         }
2472         HvAUX(stash)->xhv_aux_flags &= ~HvAUXf_SCAN_STASH;
2473     }
2474 }
2475
2476 GV *
2477 Perl_newGVgen_flags(pTHX_ const char *pack, U32 flags)
2478 {
2479     PERL_ARGS_ASSERT_NEWGVGEN_FLAGS;
2480     assert(!(flags & ~SVf_UTF8));
2481
2482     return gv_fetchpv(Perl_form(aTHX_ "%"UTF8f"::_GEN_%ld",
2483                                 UTF8fARG(flags, strlen(pack), pack),
2484                                 (long)PL_gensym++),
2485                       GV_ADD, SVt_PVGV);
2486 }
2487
2488 /* hopefully this is only called on local symbol table entries */
2489
2490 GP*
2491 Perl_gp_ref(pTHX_ GP *gp)
2492 {
2493     if (!gp)
2494         return NULL;
2495     gp->gp_refcnt++;
2496     if (gp->gp_cv) {
2497         if (gp->gp_cvgen) {
2498             /* If the GP they asked for a reference to contains
2499                a method cache entry, clear it first, so that we
2500                don't infect them with our cached entry */
2501             SvREFCNT_dec_NN(gp->gp_cv);
2502             gp->gp_cv = NULL;
2503             gp->gp_cvgen = 0;
2504         }
2505     }
2506     return gp;
2507 }
2508
2509 void
2510 Perl_gp_free(pTHX_ GV *gv)
2511 {
2512     GP* gp;
2513     int attempts = 100;
2514
2515     if (!gv || !isGV_with_GP(gv) || !(gp = GvGP(gv)))
2516         return;
2517     if (gp->gp_refcnt == 0) {
2518         Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
2519                          "Attempt to free unreferenced glob pointers"
2520                          pTHX__FORMAT pTHX__VALUE);
2521         return;
2522     }
2523     if (gp->gp_refcnt > 1) {
2524        borrowed:
2525         if (gp->gp_egv == gv)
2526             gp->gp_egv = 0;
2527         gp->gp_refcnt--;
2528         GvGP_set(gv, NULL);
2529         return;
2530     }
2531
2532     while (1) {
2533       /* Copy and null out all the glob slots, so destructors do not see
2534          freed SVs. */
2535       HEK * const file_hek = gp->gp_file_hek;
2536       SV  * const sv       = gp->gp_sv;
2537       AV  * const av       = gp->gp_av;
2538       HV  * const hv       = gp->gp_hv;
2539       IO  * const io       = gp->gp_io;
2540       CV  * const cv       = gp->gp_cv;
2541       CV  * const form     = gp->gp_form;
2542
2543       gp->gp_file_hek = NULL;
2544       gp->gp_sv       = NULL;
2545       gp->gp_av       = NULL;
2546       gp->gp_hv       = NULL;
2547       gp->gp_io       = NULL;
2548       gp->gp_cv       = NULL;
2549       gp->gp_form     = NULL;
2550
2551       if (file_hek)
2552         unshare_hek(file_hek);
2553
2554       SvREFCNT_dec(sv);
2555       SvREFCNT_dec(av);
2556       /* FIXME - another reference loop GV -> symtab -> GV ?
2557          Somehow gp->gp_hv can end up pointing at freed garbage.  */
2558       if (hv && SvTYPE(hv) == SVt_PVHV) {
2559         const HEK *hvname_hek = HvNAME_HEK(hv);
2560         if (PL_stashcache && hvname_hek) {
2561            DEBUG_o(Perl_deb(aTHX_
2562                           "gp_free clearing PL_stashcache for '%"HEKf"'\n",
2563                            HEKfARG(hvname_hek)));
2564            (void)hv_deletehek(PL_stashcache, hvname_hek, G_DISCARD);
2565         }
2566         SvREFCNT_dec(hv);
2567       }
2568       if (io && SvREFCNT(io) == 1 && IoIFP(io)
2569              && (IoTYPE(io) == IoTYPE_WRONLY ||
2570                  IoTYPE(io) == IoTYPE_RDWR   ||
2571                  IoTYPE(io) == IoTYPE_APPEND)
2572              && ckWARN_d(WARN_IO)
2573              && IoIFP(io) != PerlIO_stdin()
2574              && IoIFP(io) != PerlIO_stdout()
2575              && IoIFP(io) != PerlIO_stderr()
2576              && !(IoFLAGS(io) & IOf_FAKE_DIRP))
2577         io_close(io, gv, FALSE, TRUE);
2578       SvREFCNT_dec(io);
2579       SvREFCNT_dec(cv);
2580       SvREFCNT_dec(form);
2581
2582       /* Possibly reallocated by a destructor */
2583       gp = GvGP(gv);
2584
2585       if (!gp->gp_file_hek
2586        && !gp->gp_sv
2587        && !gp->gp_av
2588        && !gp->gp_hv
2589        && !gp->gp_io
2590        && !gp->gp_cv
2591        && !gp->gp_form) break;
2592
2593       if (--attempts == 0) {
2594         Perl_die(aTHX_
2595           "panic: gp_free failed to free glob pointer - "
2596           "something is repeatedly re-creating entries"
2597         );
2598       }
2599     }
2600
2601     /* Possibly incremented by a destructor doing glob assignment */
2602     if (gp->gp_refcnt > 1) goto borrowed;
2603     Safefree(gp);
2604     GvGP_set(gv, NULL);
2605 }
2606
2607 int
2608 Perl_magic_freeovrld(pTHX_ SV *sv, MAGIC *mg)
2609 {
2610     AMT * const amtp = (AMT*)mg->mg_ptr;
2611     PERL_UNUSED_ARG(sv);
2612
2613     PERL_ARGS_ASSERT_MAGIC_FREEOVRLD;
2614
2615     if (amtp && AMT_AMAGIC(amtp)) {
2616         int i;
2617         for (i = 1; i < NofAMmeth; i++) {
2618             CV * const cv = amtp->table[i];
2619             if (cv) {
2620                 SvREFCNT_dec_NN(MUTABLE_SV(cv));
2621                 amtp->table[i] = NULL;
2622             }
2623         }
2624     }
2625  return 0;
2626 }
2627
2628 /* Updates and caches the CV's */
2629 /* Returns:
2630  * 1 on success and there is some overload
2631  * 0 if there is no overload
2632  * -1 if some error occurred and it couldn't croak
2633  */
2634
2635 int
2636 Perl_Gv_AMupdate(pTHX_ HV *stash, bool destructing)
2637 {
2638   MAGIC* const mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
2639   AMT amt;
2640   const struct mro_meta* stash_meta = HvMROMETA(stash);
2641   U32 newgen;
2642
2643   PERL_ARGS_ASSERT_GV_AMUPDATE;
2644
2645   newgen = PL_sub_generation + stash_meta->pkg_gen + stash_meta->cache_gen;
2646   if (mg) {
2647       const AMT * const amtp = (AMT*)mg->mg_ptr;
2648       if (amtp->was_ok_sub == newgen) {
2649           return AMT_AMAGIC(amtp) ? 1 : 0;
2650       }
2651       sv_unmagic(MUTABLE_SV(stash), PERL_MAGIC_overload_table);
2652   }
2653
2654   DEBUG_o( Perl_deb(aTHX_ "Recalcing overload magic in package %s\n",HvNAME_get(stash)) );
2655
2656   Zero(&amt,1,AMT);
2657   amt.was_ok_sub = newgen;
2658   amt.fallback = AMGfallNO;
2659   amt.flags = 0;
2660
2661   {
2662     int filled = 0;
2663     int i;
2664     bool deref_seen = 0;
2665
2666
2667     /* Work with "fallback" key, which we assume to be first in PL_AMG_names */
2668
2669     /* Try to find via inheritance. */
2670     GV *gv = gv_fetchmeth_pvn(stash, PL_AMG_names[0], 2, -1, 0);
2671     SV * const sv = gv ? GvSV(gv) : NULL;
2672     CV* cv;
2673
2674     if (!gv)
2675     {
2676       if (!gv_fetchmeth_pvn(stash, "((", 2, -1, 0))
2677         goto no_table;
2678     }
2679 #ifdef PERL_DONT_CREATE_GVSV
2680     else if (!sv) {
2681         NOOP;   /* Equivalent to !SvTRUE and !SvOK  */
2682     }
2683 #endif
2684     else if (SvTRUE(sv))
2685         /* don't need to set overloading here because fallback => 1
2686          * is the default setting for classes without overloading */
2687         amt.fallback=AMGfallYES;
2688     else if (SvOK(sv)) {
2689         amt.fallback=AMGfallNEVER;
2690         filled = 1;
2691     }
2692     else {
2693         filled = 1;
2694     }
2695
2696     assert(SvOOK(stash));
2697     /* initially assume the worst */
2698     HvAUX(stash)->xhv_aux_flags &= ~HvAUXf_NO_DEREF;
2699
2700     for (i = 1; i < NofAMmeth; i++) {
2701         const char * const cooky = PL_AMG_names[i];
2702         /* Human-readable form, for debugging: */
2703         const char * const cp = AMG_id2name(i);
2704         const STRLEN l = PL_AMG_namelens[i];
2705
2706         DEBUG_o( Perl_deb(aTHX_ "Checking overloading of \"%s\" in package \"%.256s\"\n",
2707                      cp, HvNAME_get(stash)) );
2708         /* don't fill the cache while looking up!
2709            Creation of inheritance stubs in intermediate packages may
2710            conflict with the logic of runtime method substitution.
2711            Indeed, for inheritance A -> B -> C, if C overloads "+0",
2712            then we could have created stubs for "(+0" in A and C too.
2713            But if B overloads "bool", we may want to use it for
2714            numifying instead of C's "+0". */
2715         gv = Perl_gv_fetchmeth_pvn(aTHX_ stash, cooky, l, -1, 0);
2716         cv = 0;
2717         if (gv && (cv = GvCV(gv)) && CvHASGV(cv)) {
2718             const HEK * const gvhek =
2719                 CvNAMED(cv) ? CvNAME_HEK(cv) : GvNAME_HEK(CvGV(cv));
2720             const HEK * const stashek =
2721                 HvNAME_HEK(CvNAMED(cv) ? CvSTASH(cv) : GvSTASH(CvGV(cv)));
2722             if (HEK_LEN(gvhek) == 3 && strEQ(HEK_KEY(gvhek), "nil")
2723              && stashek && HEK_LEN(stashek) == 8
2724              && strEQ(HEK_KEY(stashek), "overload")) {
2725                 /* This is a hack to support autoloading..., while
2726                    knowing *which* methods were declared as overloaded. */
2727                 /* GvSV contains the name of the method. */
2728                 GV *ngv = NULL;
2729                 SV *gvsv = GvSV(gv);
2730
2731                 DEBUG_o( Perl_deb(aTHX_ "Resolving method \"%"SVf256\
2732                         "\" for overloaded \"%s\" in package \"%.256s\"\n",
2733                              (void*)GvSV(gv), cp, HvNAME(stash)) );
2734                 if (!gvsv || !SvPOK(gvsv)
2735                     || !(ngv = gv_fetchmethod_sv_flags(stash, gvsv, 0)))
2736                 {
2737                     /* Can be an import stub (created by "can"). */
2738                     if (destructing) {
2739                         return -1;
2740                     }
2741                     else {
2742                         const SV * const name = (gvsv && SvPOK(gvsv))
2743                                                     ? gvsv
2744                                                     : newSVpvs_flags("???", SVs_TEMP);
2745                         /* diag_listed_as: Can't resolve method "%s" overloading "%s" in package "%s" */
2746                         Perl_croak(aTHX_ "%s method \"%"SVf256
2747                                     "\" overloading \"%s\" "\
2748                                     "in package \"%"HEKf256"\"",
2749                                    (GvCVGEN(gv) ? "Stub found while resolving"
2750                                     : "Can't resolve"),
2751                                    SVfARG(name), cp,
2752                                    HEKfARG(
2753                                         HvNAME_HEK(stash)
2754                                    ));
2755                     }
2756                 }
2757                 cv = GvCV(gv = ngv);
2758             }
2759             DEBUG_o( Perl_deb(aTHX_ "Overloading \"%s\" in package \"%.256s\" via \"%.256s::%.256s\"\n",
2760                          cp, HvNAME_get(stash), HvNAME_get(GvSTASH(CvGV(cv))),
2761                          GvNAME(CvGV(cv))) );
2762             filled = 1;
2763         } else if (gv) {                /* Autoloaded... */
2764             cv = MUTABLE_CV(gv);
2765             filled = 1;
2766         }
2767         amt.table[i]=MUTABLE_CV(SvREFCNT_inc_simple(cv));
2768
2769         if (gv) {
2770             switch (i) {
2771             case to_sv_amg:
2772             case to_av_amg:
2773             case to_hv_amg:
2774             case to_gv_amg:
2775             case to_cv_amg:
2776             case nomethod_amg:
2777                 deref_seen = 1;
2778                 break;
2779             }
2780         }
2781     }
2782     if (!deref_seen)
2783         /* none of @{} etc overloaded; we can do $obj->[N] quicker.
2784          * NB - aux var invalid here, HvARRAY() could have been
2785          * reallocated since it was assigned to */
2786         HvAUX(stash)->xhv_aux_flags |= HvAUXf_NO_DEREF;
2787
2788     if (filled) {
2789       AMT_AMAGIC_on(&amt);
2790       sv_magic(MUTABLE_SV(stash), 0, PERL_MAGIC_overload_table,
2791                                                 (char*)&amt, sizeof(AMT));
2792       return TRUE;
2793     }
2794   }
2795   /* Here we have no table: */
2796  no_table:
2797   AMT_AMAGIC_off(&amt);
2798   sv_magic(MUTABLE_SV(stash), 0, PERL_MAGIC_overload_table,
2799                                                 (char*)&amt, sizeof(AMTS));
2800   return 0;
2801 }
2802
2803
2804 CV*
2805 Perl_gv_handler(pTHX_ HV *stash, I32 id)
2806 {
2807     MAGIC *mg;
2808     AMT *amtp;
2809     U32 newgen;
2810     struct mro_meta* stash_meta;
2811
2812     if (!stash || !HvNAME_get(stash))
2813         return NULL;
2814
2815     stash_meta = HvMROMETA(stash);
2816     newgen = PL_sub_generation + stash_meta->pkg_gen + stash_meta->cache_gen;
2817
2818     mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
2819     if (!mg) {
2820       do_update:
2821         if (Gv_AMupdate(stash, 0) == -1)
2822             return NULL;
2823         mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
2824     }
2825     assert(mg);
2826     amtp = (AMT*)mg->mg_ptr;
2827     if ( amtp->was_ok_sub != newgen )
2828         goto do_update;
2829     if (AMT_AMAGIC(amtp)) {
2830         CV * const ret = amtp->table[id];
2831         if (ret && isGV(ret)) {         /* Autoloading stab */
2832             /* Passing it through may have resulted in a warning
2833                "Inherited AUTOLOAD for a non-method deprecated", since
2834                our caller is going through a function call, not a method call.
2835                So return the CV for AUTOLOAD, setting $AUTOLOAD. */
2836             GV * const gv = gv_fetchmethod(stash, PL_AMG_names[id]);
2837
2838             if (gv && GvCV(gv))
2839                 return GvCV(gv);
2840         }
2841         return ret;
2842     }
2843
2844     return NULL;
2845 }
2846
2847
2848 /* Implement tryAMAGICun_MG macro.
2849    Do get magic, then see if the stack arg is overloaded and if so call it.
2850    Flags:
2851         AMGf_set     return the arg using SETs rather than assigning to
2852                      the targ
2853         AMGf_numeric apply sv_2num to the stack arg.
2854 */
2855
2856 bool
2857 Perl_try_amagic_un(pTHX_ int method, int flags) {
2858     dSP;
2859     SV* tmpsv;
2860     SV* const arg = TOPs;
2861
2862     SvGETMAGIC(arg);
2863
2864     if (SvAMAGIC(arg) && (tmpsv = amagic_call(arg, &PL_sv_undef, method,
2865                                               AMGf_noright | AMGf_unary
2866                                             | (flags & AMGf_numarg))))
2867     {
2868         if (flags & AMGf_set) {
2869             SETs(tmpsv);
2870         }
2871         else {
2872             dTARGET;
2873             if (SvPADMY(TARG)) {
2874                 sv_setsv(TARG, tmpsv);
2875                 SETTARG;
2876             }
2877             else
2878                 SETs(tmpsv);
2879         }
2880         PUTBACK;
2881         return TRUE;
2882     }
2883
2884     if ((flags & AMGf_numeric) && SvROK(arg))
2885         *sp = sv_2num(arg);
2886     return FALSE;
2887 }
2888
2889
2890 /* Implement tryAMAGICbin_MG macro.
2891    Do get magic, then see if the two stack args are overloaded and if so
2892    call it.
2893    Flags:
2894         AMGf_set     return the arg using SETs rather than assigning to
2895                      the targ
2896         AMGf_assign  op may be called as mutator (eg +=)
2897         AMGf_numeric apply sv_2num to the stack arg.
2898 */
2899
2900 bool
2901 Perl_try_amagic_bin(pTHX_ int method, int flags) {
2902     dSP;
2903     SV* const left = TOPm1s;
2904     SV* const right = TOPs;
2905
2906     SvGETMAGIC(left);
2907     if (left != right)
2908         SvGETMAGIC(right);
2909
2910     if (SvAMAGIC(left) || SvAMAGIC(right)) {
2911         SV * const tmpsv = amagic_call(left, right, method,
2912                     ((flags & AMGf_assign) && opASSIGN ? AMGf_assign: 0)
2913                   | (flags & AMGf_numarg));
2914         if (tmpsv) {
2915             if (flags & AMGf_set) {
2916                 (void)POPs;
2917                 SETs(tmpsv);
2918             }
2919             else {
2920                 dATARGET;
2921                 (void)POPs;
2922                 if (opASSIGN || SvPADMY(TARG)) {
2923                     sv_setsv(TARG, tmpsv);
2924                     SETTARG;
2925                 }
2926                 else
2927                     SETs(tmpsv);
2928             }
2929             PUTBACK;
2930             return TRUE;
2931         }
2932     }
2933     if(left==right && SvGMAGICAL(left)) {
2934         SV * const left = sv_newmortal();
2935         *(sp-1) = left;
2936         /* Print the uninitialized warning now, so it includes the vari-
2937            able name. */
2938         if (!SvOK(right)) {
2939             if (ckWARN(WARN_UNINITIALIZED)) report_uninit(right);
2940             sv_setsv_flags(left, &PL_sv_no, 0);
2941         }
2942         else sv_setsv_flags(left, right, 0);
2943         SvGETMAGIC(right);
2944     }
2945     if (flags & AMGf_numeric) {
2946         if (SvROK(TOPm1s))
2947             *(sp-1) = sv_2num(TOPm1s);
2948         if (SvROK(right))
2949             *sp     = sv_2num(right);
2950     }
2951     return FALSE;
2952 }
2953
2954 SV *
2955 Perl_amagic_deref_call(pTHX_ SV *ref, int method) {
2956     SV *tmpsv = NULL;
2957     HV *stash;
2958
2959     PERL_ARGS_ASSERT_AMAGIC_DEREF_CALL;
2960
2961     if (!SvAMAGIC(ref))
2962         return ref;
2963     /* return quickly if none of the deref ops are overloaded */
2964     stash = SvSTASH(SvRV(ref));
2965     assert(SvOOK(stash));
2966     if (HvAUX(stash)->xhv_aux_flags & HvAUXf_NO_DEREF)
2967         return ref;
2968
2969     while ((tmpsv = amagic_call(ref, &PL_sv_undef, method,
2970                                 AMGf_noright | AMGf_unary))) { 
2971         if (!SvROK(tmpsv))
2972             Perl_croak(aTHX_ "Overloaded dereference did not return a reference");
2973         if (tmpsv == ref || SvRV(tmpsv) == SvRV(ref)) {
2974             /* Bail out if it returns us the same reference.  */
2975             return tmpsv;
2976         }
2977         ref = tmpsv;
2978         if (!SvAMAGIC(ref))
2979             break;
2980     }
2981     return tmpsv ? tmpsv : ref;
2982 }
2983
2984 bool
2985 Perl_amagic_is_enabled(pTHX_ int method)
2986 {
2987       SV *lex_mask = cop_hints_fetch_pvs(PL_curcop, "overloading", 0);
2988
2989       assert(PL_curcop->cop_hints & HINT_NO_AMAGIC);
2990
2991       if ( !lex_mask || !SvOK(lex_mask) )
2992           /* overloading lexically disabled */
2993           return FALSE;
2994       else if ( lex_mask && SvPOK(lex_mask) ) {
2995           /* we have an entry in the hints hash, check if method has been
2996            * masked by overloading.pm */
2997           STRLEN len;
2998           const int offset = method / 8;
2999           const int bit    = method % 8;
3000           char *pv = SvPV(lex_mask, len);
3001
3002           /* Bit set, so this overloading operator is disabled */
3003           if ( (STRLEN)offset < len && pv[offset] & ( 1 << bit ) )
3004               return FALSE;
3005       }
3006       return TRUE;
3007 }
3008
3009 SV*
3010 Perl_amagic_call(pTHX_ SV *left, SV *right, int method, int flags)
3011 {
3012   dVAR;
3013   MAGIC *mg;
3014   CV *cv=NULL;
3015   CV **cvp=NULL, **ocvp=NULL;
3016   AMT *amtp=NULL, *oamtp=NULL;
3017   int off = 0, off1, lr = 0, notfound = 0;
3018   int postpr = 0, force_cpy = 0;
3019   int assign = AMGf_assign & flags;
3020   const int assignshift = assign ? 1 : 0;
3021   int use_default_op = 0;
3022   int force_scalar = 0;
3023 #ifdef DEBUGGING
3024   int fl=0;
3025 #endif
3026   HV* stash=NULL;
3027
3028   PERL_ARGS_ASSERT_AMAGIC_CALL;
3029
3030   if ( PL_curcop->cop_hints & HINT_NO_AMAGIC ) {
3031       if (!amagic_is_enabled(method)) return NULL;
3032   }
3033
3034   if (!(AMGf_noleft & flags) && SvAMAGIC(left)
3035       && (stash = SvSTASH(SvRV(left))) && Gv_AMG(stash)
3036       && (mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table))
3037       && (ocvp = cvp = (AMT_AMAGIC((AMT*)mg->mg_ptr)
3038                         ? (oamtp = amtp = (AMT*)mg->mg_ptr)->table
3039                         : NULL))
3040       && ((cv = cvp[off=method+assignshift])
3041           || (assign && amtp->fallback > AMGfallNEVER && /* fallback to
3042                                                           * usual method */
3043                   (
3044 #ifdef DEBUGGING
3045                    fl = 1,
3046 #endif
3047                    cv = cvp[off=method])))) {
3048     lr = -1;                    /* Call method for left argument */
3049   } else {
3050     if (cvp && amtp->fallback > AMGfallNEVER && flags & AMGf_unary) {
3051       int logic;
3052
3053       /* look for substituted methods */
3054       /* In all the covered cases we should be called with assign==0. */
3055          switch (method) {
3056          case inc_amg:
3057            force_cpy = 1;
3058            if ((cv = cvp[off=add_ass_amg])
3059                || ((cv = cvp[off = add_amg]) && (force_cpy = 0, postpr = 1))) {
3060              right = &PL_sv_yes; lr = -1; assign = 1;
3061            }
3062            break;
3063          case dec_amg:
3064            force_cpy = 1;
3065            if ((cv = cvp[off = subtr_ass_amg])
3066                || ((cv = cvp[off = subtr_amg]) && (force_cpy = 0, postpr=1))) {
3067              right = &PL_sv_yes; lr = -1; assign = 1;
3068            }
3069            break;
3070          case bool__amg:
3071            (void)((cv = cvp[off=numer_amg]) || (cv = cvp[off=string_amg]));
3072            break;
3073          case numer_amg:
3074            (void)((cv = cvp[off=string_amg]) || (cv = cvp[off=bool__amg]));
3075            break;
3076          case string_amg:
3077            (void)((cv = cvp[off=numer_amg]) || (cv = cvp[off=bool__amg]));
3078            break;
3079          case not_amg:
3080            (void)((cv = cvp[off=bool__amg])
3081                   || (cv = cvp[off=numer_amg])
3082                   || (cv = cvp[off=string_amg]));
3083            if (cv)
3084                postpr = 1;
3085            break;
3086          case copy_amg:
3087            {
3088              /*
3089                   * SV* ref causes confusion with the interpreter variable of
3090                   * the same name
3091                   */
3092              SV* const tmpRef=SvRV(left);
3093              if (!SvROK(tmpRef) && SvTYPE(tmpRef) <= SVt_PVMG) {
3094                 /*
3095                  * Just to be extra cautious.  Maybe in some
3096                  * additional cases sv_setsv is safe, too.
3097                  */
3098                 SV* const newref = newSVsv(tmpRef);
3099                 SvOBJECT_on(newref);
3100                 /* No need to do SvAMAGIC_on here, as SvAMAGIC macros
3101                    delegate to the stash. */
3102                 SvSTASH_set(newref, MUTABLE_HV(SvREFCNT_inc(SvSTASH(tmpRef))));
3103                 return newref;
3104              }
3105            }
3106            break;
3107          case abs_amg:
3108            if ((cvp[off1=lt_amg] || cvp[off1=ncmp_amg])
3109                && ((cv = cvp[off=neg_amg]) || (cv = cvp[off=subtr_amg]))) {
3110              SV* const nullsv=sv_2mortal(newSViv(0));
3111              if (off1==lt_amg) {
3112                SV* const lessp = amagic_call(left,nullsv,
3113                                        lt_amg,AMGf_noright);
3114                logic = SvTRUE(lessp);
3115              } else {
3116                SV* const lessp = amagic_call(left,nullsv,
3117                                        ncmp_amg,AMGf_noright);
3118                logic = (SvNV(lessp) < 0);
3119              }
3120              if (logic) {
3121                if (off==subtr_amg) {
3122                  right = left;
3123                  left = nullsv;
3124                  lr = 1;
3125                }
3126              } else {
3127                return left;
3128              }
3129            }
3130            break;
3131          case neg_amg:
3132            if ((cv = cvp[off=subtr_amg])) {
3133              right = left;
3134              left = sv_2mortal(newSViv(0));
3135              lr = 1;
3136            }
3137            break;
3138          case int_amg:
3139          case iter_amg:                 /* XXXX Eventually should do to_gv. */
3140          case ftest_amg:                /* XXXX Eventually should do to_gv. */
3141          case regexp_amg:
3142              /* FAIL safe */
3143              return NULL;       /* Delegate operation to standard mechanisms. */
3144
3145          case to_sv_amg:
3146          case to_av_amg:
3147          case to_hv_amg:
3148          case to_gv_amg:
3149          case to_cv_amg:
3150              /* FAIL safe */
3151              return left;       /* Delegate operation to standard mechanisms. */
3152
3153          default:
3154            goto not_found;
3155          }
3156          if (!cv) goto not_found;
3157     } else if (!(AMGf_noright & flags) && SvAMAGIC(right)
3158                && (stash = SvSTASH(SvRV(right))) && Gv_AMG(stash)
3159                && (mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table))
3160                && (cvp = (AMT_AMAGIC((AMT*)mg->mg_ptr)
3161                           ? (amtp = (AMT*)mg->mg_ptr)->table
3162                           : NULL))
3163                && (cv = cvp[off=method])) { /* Method for right
3164                                              * argument found */
3165       lr=1;
3166     } else if (((cvp && amtp->fallback > AMGfallNEVER)
3167                 || (ocvp && oamtp->fallback > AMGfallNEVER))
3168                && !(flags & AMGf_unary)) {
3169                                 /* We look for substitution for
3170                                  * comparison operations and
3171                                  * concatenation */
3172       if (method==concat_amg || method==concat_ass_amg
3173           || method==repeat_amg || method==repeat_ass_amg) {
3174         return NULL;            /* Delegate operation to string conversion */
3175       }
3176       off = -1;
3177       switch (method) {
3178          case lt_amg:
3179          case le_amg:
3180          case gt_amg:
3181          case ge_amg:
3182          case eq_amg:
3183          case ne_amg:
3184              off = ncmp_amg;
3185              break;
3186          case slt_amg:
3187          case sle_amg:
3188          case sgt_amg:
3189          case sge_amg:
3190          case seq_amg:
3191          case sne_amg:
3192              off = scmp_amg;
3193              break;
3194          }
3195       if (off != -1) {
3196           if (ocvp && (oamtp->fallback > AMGfallNEVER)) {
3197               cv = ocvp[off];
3198               lr = -1;
3199           }
3200           if (!cv && (cvp && amtp->fallback > AMGfallNEVER)) {
3201               cv = cvp[off];
3202               lr = 1;
3203           }
3204       }
3205       if (cv)
3206           postpr = 1;
3207       else
3208           goto not_found;
3209     } else {
3210     not_found:                  /* No method found, either report or croak */
3211       switch (method) {
3212          case to_sv_amg:
3213          case to_av_amg:
3214          case to_hv_amg:
3215          case to_gv_amg:
3216          case to_cv_amg:
3217              /* FAIL safe */
3218              return left;       /* Delegate operation to standard mechanisms. */
3219       }
3220       if (ocvp && (cv=ocvp[nomethod_amg])) { /* Call report method */
3221         notfound = 1; lr = -1;
3222       } else if (cvp && (cv=cvp[nomethod_amg])) {
3223         notfound = 1; lr = 1;
3224       } else if ((use_default_op =
3225                   (!ocvp || oamtp->fallback >= AMGfallYES)
3226                   && (!cvp || amtp->fallback >= AMGfallYES))
3227                  && !DEBUG_o_TEST) {
3228         /* Skip generating the "no method found" message.  */
3229         return NULL;
3230       } else {
3231         SV *msg;
3232         if (off==-1) off=method;
3233         msg = sv_2mortal(Perl_newSVpvf(aTHX_
3234                       "Operation \"%s\": no method found,%sargument %s%"SVf"%s%"SVf,
3235                       AMG_id2name(method + assignshift),
3236                       (flags & AMGf_unary ? " " : "\n\tleft "),
3237                       SvAMAGIC(left)?
3238                         "in overloaded package ":
3239                         "has no overloaded magic",
3240                       SvAMAGIC(left)?
3241                         SVfARG(sv_2mortal(newSVhek(HvNAME_HEK(SvSTASH(SvRV(left)))))):
3242                         SVfARG(&PL_sv_no),
3243                       SvAMAGIC(right)?
3244                         ",\n\tright argument in overloaded package ":
3245                         (flags & AMGf_unary
3246                          ? ""
3247                          : ",\n\tright argument has no overloaded magic"),
3248                       SvAMAGIC(right)?
3249                         SVfARG(sv_2mortal(newSVhek(HvNAME_HEK(SvSTASH(SvRV(right)))))):
3250                         SVfARG(&PL_sv_no)));
3251         if (use_default_op) {
3252           DEBUG_o( Perl_deb(aTHX_ "%"SVf, SVfARG(msg)) );
3253         } else {
3254           Perl_croak(aTHX_ "%"SVf, SVfARG(msg));
3255         }
3256         return NULL;
3257       }
3258       force_cpy = force_cpy || assign;
3259     }
3260   }
3261
3262   switch (method) {
3263     /* in these cases, we're calling '+' or '-' as a fallback for a ++ or --
3264      * operation. we need this to return a value, so that it can be assigned
3265      * later on, in the postpr block (case inc_amg/dec_amg), even if the
3266      * increment or decrement was itself called in void context */
3267     case inc_amg:
3268       if (off == add_amg)
3269         force_scalar = 1;
3270       break;
3271     case dec_amg:
3272       if (off == subtr_amg)
3273         force_scalar = 1;
3274       break;
3275     /* in these cases, we're calling an assignment variant of an operator
3276      * (+= rather than +, for instance). regardless of whether it's a
3277      * fallback or not, it always has to return a value, which will be
3278      * assigned to the proper variable later */
3279     case add_amg:
3280     case subtr_amg:
3281     case mult_amg:
3282     case div_amg:
3283     case modulo_amg:
3284     case pow_amg:
3285     case lshift_amg:
3286     case rshift_amg:
3287     case repeat_amg:
3288     case concat_amg:
3289     case band_amg:
3290     case bor_amg:
3291     case bxor_amg:
3292     case sband_amg:
3293     case sbor_amg:
3294     case sbxor_amg:
3295       if (assign)
3296         force_scalar = 1;
3297       break;
3298     /* the copy constructor always needs to return a value */
3299     case copy_amg:
3300       force_scalar = 1;
3301       break;
3302     /* because of the way these are implemented (they don't perform the
3303      * dereferencing themselves, they return a reference that perl then
3304      * dereferences later), they always have to be in scalar context */
3305     case to_sv_amg:
3306     case to_av_amg:
3307     case to_hv_amg:
3308     case to_gv_amg:
3309     case to_cv_amg:
3310       force_scalar = 1;
3311       break;
3312     /* these don't have an op of their own; they're triggered by their parent
3313      * op, so the context there isn't meaningful ('$a and foo()' in void
3314      * context still needs to pass scalar context on to $a's bool overload) */
3315     case bool__amg:
3316     case numer_amg:
3317     case string_amg:
3318       force_scalar = 1;
3319       break;
3320   }
3321
3322 #ifdef DEBUGGING
3323   if (!notfound) {
3324     DEBUG_o(Perl_deb(aTHX_
3325                      "Overloaded operator \"%s\"%s%s%s:\n\tmethod%s found%s in package %"SVf"%s\n",
3326                      AMG_id2name(off),
3327                      method+assignshift==off? "" :
3328                      " (initially \"",
3329                      method+assignshift==off? "" :
3330                      AMG_id2name(method+assignshift),
3331                      method+assignshift==off? "" : "\")",
3332                      flags & AMGf_unary? "" :
3333                      lr==1 ? " for right argument": " for left argument",
3334                      flags & AMGf_unary? " for argument" : "",
3335                      stash ? SVfARG(sv_2mortal(newSVhek(HvNAME_HEK(stash)))) : SVfARG(newSVpvs_flags("null", SVs_TEMP)),
3336                      fl? ",\n\tassignment variant used": "") );
3337   }
3338 #endif
3339     /* Since we use shallow copy during assignment, we need
3340      * to dublicate the contents, probably calling user-supplied
3341      * version of copy operator
3342      */
3343     /* We need to copy in following cases:
3344      * a) Assignment form was called.
3345      *          assignshift==1,  assign==T, method + 1 == off
3346      * b) Increment or decrement, called directly.
3347      *          assignshift==0,  assign==0, method + 0 == off
3348      * c) Increment or decrement, translated to assignment add/subtr.
3349      *          assignshift==0,  assign==T,
3350      *          force_cpy == T
3351      * d) Increment or decrement, translated to nomethod.
3352      *          assignshift==0,  assign==0,
3353      *          force_cpy == T
3354      * e) Assignment form translated to nomethod.
3355      *          assignshift==1,  assign==T, method + 1 != off
3356      *          force_cpy == T
3357      */
3358     /*  off is method, method+assignshift, or a result of opcode substitution.
3359      *  In the latter case assignshift==0, so only notfound case is important.
3360      */
3361   if ( (lr == -1) && ( ( (method + assignshift == off)
3362         && (assign || (method == inc_amg) || (method == dec_amg)))
3363       || force_cpy) )
3364   {
3365       /* newSVsv does not behave as advertised, so we copy missing
3366        * information by hand */
3367       SV *tmpRef = SvRV(left);
3368       SV *rv_copy;
3369       if (SvREFCNT(tmpRef) > 1 && (rv_copy = AMG_CALLunary(left,copy_amg))) {
3370           SvRV_set(left, rv_copy);
3371           SvSETMAGIC(left);
3372           SvREFCNT_dec_NN(tmpRef);  
3373       }
3374   }
3375
3376   {
3377     dSP;
3378     BINOP myop;
3379     SV* res;
3380     const bool oldcatch = CATCH_GET;
3381     I32 oldmark, nret;
3382     U8 gimme = force_scalar ? G_SCALAR : GIMME_V;
3383
3384     CATCH_SET(TRUE);
3385     Zero(&myop, 1, BINOP);
3386     myop.op_last = (OP *) &myop;
3387     myop.op_next = NULL;
3388     myop.op_flags = OPf_STACKED;
3389
3390     switch (gimme) {
3391         case G_VOID:
3392             myop.op_flags |= OPf_WANT_VOID;
3393             break;
3394         case G_ARRAY:
3395             if (flags & AMGf_want_list) {
3396                 myop.op_flags |= OPf_WANT_LIST;
3397                 break;
3398             }
3399             /* FALLTHROUGH */
3400         default:
3401             myop.op_flags |= OPf_WANT_SCALAR;
3402             break;
3403     }
3404
3405     PUSHSTACKi(PERLSI_OVERLOAD);
3406     ENTER;
3407     SAVEOP();
3408     PL_op = (OP *) &myop;
3409     if (PERLDB_SUB && PL_curstash != PL_debstash)
3410         PL_op->op_private |= OPpENTERSUB_DB;
3411     Perl_pp_pushmark(aTHX);
3412
3413     EXTEND(SP, notfound + 5);
3414     PUSHs(lr>0? right: left);
3415     PUSHs(lr>0? left: right);
3416     PUSHs( lr > 0 ? &PL_sv_yes : ( assign ? &PL_sv_undef : &PL_sv_no ));
3417     if (notfound) {
3418       PUSHs(newSVpvn_flags(AMG_id2name(method + assignshift),
3419                            AMG_id2namelen(method + assignshift), SVs_TEMP));
3420     }
3421     else if (flags & AMGf_numarg)
3422       PUSHs(&PL_sv_undef);
3423     if (flags & AMGf_numarg)
3424       PUSHs(&PL_sv_yes);
3425     PUSHs(MUTABLE_SV(cv));
3426     PUTBACK;
3427     oldmark = TOPMARK;
3428
3429     if ((PL_op = PL_ppaddr[OP_ENTERSUB](aTHX)))
3430       CALLRUNOPS(aTHX);
3431     LEAVE;
3432     SPAGAIN;
3433     nret = SP - (PL_stack_base + oldmark);
3434
3435     switch (gimme) {
3436         case G_VOID:
3437             /* returning NULL has another meaning, and we check the context
3438              * at the call site too, so this can be differentiated from the
3439              * scalar case */
3440             res = &PL_sv_undef;
3441             SP = PL_stack_base + oldmark;
3442             break;
3443         case G_ARRAY: {
3444             if (flags & AMGf_want_list) {
3445                 res = sv_2mortal((SV *)newAV());
3446                 av_extend((AV *)res, nret);
3447                 while (nret--)
3448                     av_store((AV *)res, nret, POPs);
3449                 break;
3450             }
3451             /* FALLTHROUGH */
3452         }
3453         default:
3454             res = POPs;
3455             break;
3456     }
3457
3458     PUTBACK;
3459     POPSTACK;
3460     CATCH_SET(oldcatch);
3461
3462     if (postpr) {
3463       int ans;
3464       switch (method) {
3465       case le_amg:
3466       case sle_amg:
3467         ans=SvIV(res)<=0; break;
3468       case lt_amg:
3469       case slt_amg:
3470         ans=SvIV(res)<0; break;
3471       case ge_amg:
3472       case sge_amg:
3473         ans=SvIV(res)>=0; break;
3474       case gt_amg:
3475       case sgt_amg:
3476         ans=SvIV(res)>0; break;
3477       case eq_amg:
3478       case seq_amg:
3479         ans=SvIV(res)==0; break;
3480       case ne_amg:
3481       case sne_amg:
3482         ans=SvIV(res)!=0; break;
3483       case inc_amg:
3484       case dec_amg:
3485         SvSetSV(left,res); return left;
3486       case not_amg:
3487         ans=!SvTRUE(res); break;
3488       default:
3489         ans=0; break;
3490       }
3491       return boolSV(ans);
3492     } else if (method==copy_amg) {
3493       if (!SvROK(res)) {
3494         Perl_croak(aTHX_ "Copy method did not return a reference");
3495       }
3496       return SvREFCNT_inc(SvRV(res));
3497     } else {
3498       return res;
3499     }
3500   }
3501 }
3502
3503 void
3504 Perl_gv_name_set(pTHX_ GV *gv, const char *name, U32 len, U32 flags)
3505 {
3506     dVAR;
3507     U32 hash;
3508
3509     PERL_ARGS_ASSERT_GV_NAME_SET;
3510
3511     if (len > I32_MAX)
3512         Perl_croak(aTHX_ "panic: gv name too long (%"UVuf")", (UV) len);
3513
3514     if (!(flags & GV_ADD) && GvNAME_HEK(gv)) {
3515         unshare_hek(GvNAME_HEK(gv));
3516     }
3517
3518     PERL_HASH(hash, name, len);
3519     GvNAME_HEK(gv) = share_hek(name, (flags & SVf_UTF8 ? -(I32)len : (I32)len), hash);
3520 }
3521
3522 /*
3523 =for apidoc gv_try_downgrade
3524
3525 If the typeglob C<gv> can be expressed more succinctly, by having
3526 something other than a real GV in its place in the stash, replace it
3527 with the optimised form.  Basic requirements for this are that C<gv>
3528 is a real typeglob, is sufficiently ordinary, and is only referenced
3529 from its package.  This function is meant to be used when a GV has been
3530 looked up in part to see what was there, causing upgrading, but based
3531 on what was found it turns out that the real GV isn't required after all.
3532
3533 If C<gv> is a completely empty typeglob, it is deleted from the stash.
3534
3535 If C<gv> is a typeglob containing only a sufficiently-ordinary constant
3536 sub, the typeglob is replaced with a scalar-reference placeholder that
3537 more compactly represents the same thing.
3538
3539 =cut
3540 */
3541
3542 void
3543 Perl_gv_try_downgrade(pTHX_ GV *gv)
3544 {
3545     HV *stash;
3546     CV *cv;
3547     HEK *namehek;
3548     SV **gvp;
3549     PERL_ARGS_ASSERT_GV_TRY_DOWNGRADE;
3550
3551     /* XXX Why and where does this leave dangling pointers during global
3552        destruction? */
3553     if (PL_phase == PERL_PHASE_DESTRUCT) return;
3554
3555     if (!(SvREFCNT(gv) == 1 && SvTYPE(gv) == SVt_PVGV && !SvFAKE(gv) &&
3556             !SvOBJECT(gv) && !SvREADONLY(gv) &&
3557             isGV_with_GP(gv) && GvGP(gv) &&
3558             !GvINTRO(gv) && GvREFCNT(gv) == 1 &&
3559             !GvSV(gv) && !GvAV(gv) && !GvHV(gv) && !GvIOp(gv) && !GvFORM(gv) &&
3560             GvEGVx(gv) == gv && (stash = GvSTASH(gv))))
3561         return;
3562     if (gv == PL_statgv || gv == PL_last_in_gv || gv == PL_stderrgv)
3563         return;
3564     if (SvMAGICAL(gv)) {
3565         MAGIC *mg;
3566         /* only backref magic is allowed */
3567         if (SvGMAGICAL(gv) || SvSMAGICAL(gv))
3568             return;
3569         for (mg = SvMAGIC(gv); mg; mg = mg->mg_moremagic) {
3570             if (mg->mg_type != PERL_MAGIC_backref)
3571                 return;
3572         }
3573     }
3574     cv = GvCV(gv);
3575     if (!cv) {
3576         HEK *gvnhek = GvNAME_HEK(gv);
3577         (void)hv_deletehek(stash, gvnhek, G_DISCARD);
3578     } else if (GvMULTI(gv) && cv && SvREFCNT(cv) == 1 &&
3579             !SvOBJECT(cv) && !SvMAGICAL(cv) && !SvREADONLY(cv) &&
3580             CvSTASH(cv) == stash && !CvNAMED(cv) && CvGV(cv) == gv &&
3581             CvCONST(cv) && !CvMETHOD(cv) && !CvLVALUE(cv) && !CvUNIQUE(cv) &&
3582             !CvNODEBUG(cv) && !CvCLONE(cv) && !CvCLONED(cv) && !CvANON(cv) &&
3583             (namehek = GvNAME_HEK(gv)) &&
3584             (gvp = hv_fetchhek(stash, namehek, 0)) &&
3585             *gvp == (SV*)gv) {
3586         SV *value = SvREFCNT_inc(CvXSUBANY(cv).any_ptr);
3587         const bool imported = !!GvIMPORTED_CV(gv);
3588         SvREFCNT(gv) = 0;
3589         sv_clear((SV*)gv);
3590         SvREFCNT(gv) = 1;
3591         SvFLAGS(gv) = SVt_IV|SVf_ROK|SVprv_PCS_IMPORTED * imported;
3592
3593         /* See also: 'SET_SVANY_FOR_BODYLESS_IV' in sv.c */
3594         SvANY(gv) = (XPVGV*)((char*)&(gv->sv_u.svu_iv) -
3595                                 STRUCT_OFFSET(XPVIV, xiv_iv));
3596         SvRV_set(gv, value);
3597     }
3598 }
3599
3600 GV *
3601 Perl_gv_override(pTHX_ const char * const name, const STRLEN len)
3602 {
3603     GV *gv = gv_fetchpvn(name, len, GV_NOTQUAL, SVt_PVCV);
3604     GV * const *gvp;
3605     PERL_ARGS_ASSERT_GV_OVERRIDE;
3606     if (gv && GvCVu(gv) && GvIMPORTED_CV(gv)) return gv;
3607     gvp = (GV**)hv_fetch(PL_globalstash, name, len, FALSE);
3608     gv = gvp ? *gvp : NULL;
3609     if (gv && !isGV(gv)) {
3610         if (!SvPCS_IMPORTED(gv)) return NULL;
3611         gv_init(gv, PL_globalstash, name, len, 0);
3612         return gv;
3613     }
3614     return gv && GvCVu(gv) && GvIMPORTED_CV(gv) ? gv : NULL;
3615 }
3616
3617 #include "XSUB.h"
3618
3619 static void
3620 core_xsub(pTHX_ CV* cv)
3621 {
3622     Perl_croak(aTHX_
3623        "&CORE::%s cannot be called directly", GvNAME(CvGV(cv))
3624     );
3625 }
3626
3627 /*
3628  * ex: set ts=8 sts=4 sw=4 et:
3629  */