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