68018162f16efb62c64034a2e42c0f7e616e9801
[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.c"
38 #include "keywords.h"
39 #include "feature.h"
40
41 static const char S_autoload[] = "AUTOLOAD";
42 static const STRLEN S_autolen = sizeof(S_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 || PERLDB_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 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 ? 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 SvSetSV.  Converting
308 any scalar that is 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 SVf_UTF8 if C<name> is a UTF8 string, or
322 the return value of SvUTF8(sv).  It can also take the
323 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 gv_init_pvn().  It does not work with UTF8 strings, as it
329 has no flags parameter.  If the C<multi> parameter is set, the
330 GV_ADDMULTI flag will be passed to gv_init_pvn().
331
332 =for apidoc gv_init_pv
333
334 Same as 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 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
389         default: NOOP;
390         }
391         SvRV_set(gv, NULL);
392         SvROK_off(gv);
393     }
394
395
396     if (old_type < SVt_PVGV) {
397         if (old_type >= SVt_PV)
398             SvCUR_set(gv, 0);
399         sv_upgrade(MUTABLE_SV(gv), SVt_PVGV);
400     }
401     if (SvLEN(gv)) {
402         if (proto) {
403             SvPV_set(gv, NULL);
404             SvLEN_set(gv, 0);
405             SvPOK_off(gv);
406         } else
407             Safefree(SvPVX_mutable(gv));
408     }
409     SvIOK_off(gv);
410     isGV_with_GP_on(gv);
411
412     GvGP_set(gv, Perl_newGP(aTHX_ gv));
413     GvSTASH(gv) = stash;
414     if (stash)
415         Perl_sv_add_backref(aTHX_ MUTABLE_SV(stash), MUTABLE_SV(gv));
416     gv_name_set(gv, name, len, GV_ADD | ( flags & SVf_UTF8 ? SVf_UTF8 : 0 ));
417     if (flags & GV_ADDMULTI || doproto) /* doproto means it */
418         GvMULTI_on(gv);                 /* _was_ mentioned */
419     if (has_constant && SvTYPE(has_constant) == SVt_PVCV) {
420         /* Not actually a constant.  Just a regular sub.  */
421         CV * const cv = (CV *)has_constant;
422         GvCV_set(gv,cv);
423         if (CvSTASH(cv) == stash && (
424                CvNAME_HEK(cv) == GvNAME_HEK(gv)
425             || (  HEK_LEN(CvNAME_HEK(cv)) == HEK_LEN(GvNAME_HEK(gv))
426                && HEK_FLAGS(CvNAME_HEK(cv)) != HEK_FLAGS(GvNAME_HEK(gv))
427                && HEK_UTF8(CvNAME_HEK(cv)) == HEK_UTF8(GvNAME_HEK(gv))
428                && memEQ(HEK_KEY(CvNAME_HEK(cv)), GvNAME(gv), GvNAMELEN(gv))
429                )
430            ))
431             CvGV_set(cv,gv);
432     }
433     else if (doproto) {
434         CV *cv;
435         if (has_constant) {
436             /* newCONSTSUB takes ownership of the reference from us.  */
437             cv = newCONSTSUB_flags(stash, name, len, flags, has_constant);
438             /* In case op.c:S_process_special_blocks stole it: */
439             if (!GvCV(gv))
440                 GvCV_set(gv, (CV *)SvREFCNT_inc_simple_NN(cv));
441             assert(GvCV(gv) == cv); /* newCONSTSUB should have set this */
442             /* If this reference was a copy of another, then the subroutine
443                must have been "imported", by a Perl space assignment to a GV
444                from a reference to CV.  */
445             if (exported_constant)
446                 GvIMPORTED_CV_on(gv);
447             CvSTASH_set(cv, PL_curstash); /* XXX Why is this needed? */
448         } else {
449             cv = newSTUB(gv,1);
450         }
451         if (proto) {
452             sv_usepvn_flags(MUTABLE_SV(cv), proto, protolen,
453                             SV_HAS_TRAILING_NUL);
454             if ( proto_utf8 ) SvUTF8_on(MUTABLE_SV(cv));
455         }
456     }
457 }
458
459 STATIC void
460 S_gv_init_svtype(pTHX_ GV *gv, const svtype sv_type)
461 {
462     PERL_ARGS_ASSERT_GV_INIT_SVTYPE;
463
464     switch (sv_type) {
465     case SVt_PVIO:
466         (void)GvIOn(gv);
467         break;
468     case SVt_PVAV:
469         (void)GvAVn(gv);
470         break;
471     case SVt_PVHV:
472         (void)GvHVn(gv);
473         break;
474 #ifdef PERL_DONT_CREATE_GVSV
475     case SVt_NULL:
476     case SVt_PVCV:
477     case SVt_PVFM:
478     case SVt_PVGV:
479         break;
480     default:
481         if(GvSVn(gv)) {
482             /* Work round what appears to be a bug in Sun C++ 5.8 2005/10/13
483                If we just cast GvSVn(gv) to void, it ignores evaluating it for
484                its side effect */
485         }
486 #endif
487     }
488 }
489
490 static void core_xsub(pTHX_ CV* cv);
491
492 static GV *
493 S_maybe_add_coresub(pTHX_ HV * const stash, GV *gv,
494                           const char * const name, const STRLEN len)
495 {
496     const int code = keyword(name, len, 1);
497     static const char file[] = __FILE__;
498     CV *cv, *oldcompcv = NULL;
499     int opnum = 0;
500     bool ampable = TRUE; /* &{}-able */
501     COP *oldcurcop = NULL;
502     yy_parser *oldparser = NULL;
503     I32 oldsavestack_ix = 0;
504
505     assert(gv || stash);
506     assert(name);
507
508     if (!code) return NULL; /* Not a keyword */
509     switch (code < 0 ? -code : code) {
510      /* no support for \&CORE::infix;
511         no support for funcs that do not parse like funcs */
512     case KEY___DATA__: case KEY___END__: case KEY_and: case KEY_AUTOLOAD:
513     case KEY_BEGIN   : case KEY_CHECK  : case KEY_cmp:
514     case KEY_default : case KEY_DESTROY:
515     case KEY_do      : case KEY_dump   : case KEY_else  : case KEY_elsif  :
516     case KEY_END     : case KEY_eq     : case KEY_eval  :
517     case KEY_for     : case KEY_foreach: case KEY_format: case KEY_ge     :
518     case KEY_given   : case KEY_goto   : case KEY_grep  :
519     case KEY_gt   : case KEY_if: case KEY_INIT: case KEY_last: case KEY_le:
520     case KEY_local: case KEY_lt: case KEY_m   : case KEY_map : case KEY_my:
521     case KEY_ne   : case KEY_next : case KEY_no: case KEY_or: case KEY_our:
522     case KEY_package: case KEY_print: case KEY_printf:
523     case KEY_q    : case KEY_qq   : case KEY_qr     : case KEY_qw    :
524     case KEY_qx   : case KEY_redo : case KEY_require: case KEY_return:
525     case KEY_s    : case KEY_say  : case KEY_sort   :
526     case KEY_state: case KEY_sub  :
527     case KEY_tr   : case KEY_UNITCHECK: case KEY_unless:
528     case KEY_until: case KEY_use  : case KEY_when     : case KEY_while :
529     case KEY_x    : case KEY_xor  : case KEY_y        :
530         return NULL;
531     case KEY_chdir:
532     case KEY_chomp: case KEY_chop: case KEY_defined: case KEY_delete:
533     case KEY_each : case KEY_eof : case KEY_exec   : case KEY_exists:
534     case KEY_keys:
535     case KEY_lstat:
536     case KEY_pop:
537     case KEY_push:
538     case KEY_shift:
539     case KEY_splice: case KEY_split:
540     case KEY_stat:
541     case KEY_system:
542     case KEY_truncate: case KEY_unlink:
543     case KEY_unshift:
544     case KEY_values:
545         ampable = FALSE;
546     }
547     if (!gv) {
548         gv = (GV *)newSV(0);
549         gv_init(gv, stash, name, len, TRUE);
550     }
551     GvMULTI_on(gv);
552     if (ampable) {
553         ENTER;
554         oldcurcop = PL_curcop;
555         oldparser = PL_parser;
556         lex_start(NULL, NULL, 0);
557         oldcompcv = PL_compcv;
558         PL_compcv = NULL; /* Prevent start_subparse from setting
559                              CvOUTSIDE. */
560         oldsavestack_ix = start_subparse(FALSE,0);
561         cv = PL_compcv;
562     }
563     else {
564         /* Avoid calling newXS, as it calls us, and things start to
565            get hairy. */
566         cv = MUTABLE_CV(newSV_type(SVt_PVCV));
567         GvCV_set(gv,cv);
568         GvCVGEN(gv) = 0;
569         CvISXSUB_on(cv);
570         CvXSUB(cv) = core_xsub;
571         PoisonPADLIST(cv);
572     }
573     CvGV_set(cv, gv); /* This stops new ATTRSUB from setting CvFILE
574                          from PL_curcop. */
575     (void)gv_fetchfile(file);
576     CvFILE(cv) = (char *)file;
577     /* XXX This is inefficient, as doing things this order causes
578            a prototype check in newATTRSUB.  But we have to do
579            it this order as we need an op number before calling
580            new ATTRSUB. */
581     (void)core_prototype((SV *)cv, name, code, &opnum);
582     if (stash)
583         (void)hv_store(stash,name,len,(SV *)gv,0);
584     if (ampable) {
585 #ifdef DEBUGGING
586         CV *orig_cv = cv;
587 #endif
588         CvLVALUE_on(cv);
589         /* newATTRSUB will free the CV and return NULL if we're still
590            compiling after a syntax error */
591         if ((cv = newATTRSUB_x(
592                    oldsavestack_ix, (OP *)gv,
593                    NULL,NULL,
594                    coresub_op(
595                      opnum
596                        ? newSVuv((UV)opnum)
597                        : newSVpvn(name,len),
598                      code, opnum
599                    ),
600                    TRUE
601                )) != NULL) {
602             assert(GvCV(gv) == orig_cv);
603             if (opnum != OP_VEC && opnum != OP_SUBSTR && opnum != OP_POS
604                 && opnum != OP_UNDEF)
605                 CvLVALUE_off(cv); /* Now *that* was a neat trick. */
606         }
607         LEAVE;
608         PL_parser = oldparser;
609         PL_curcop = oldcurcop;
610         PL_compcv = oldcompcv;
611     }
612     if (cv) {
613         SV *opnumsv = opnum ? newSVuv((UV)opnum) : (SV *)NULL;
614         cv_set_call_checker(
615           cv, Perl_ck_entersub_args_core, opnumsv ? opnumsv : (SV *)cv
616         );
617         SvREFCNT_dec(opnumsv);
618     }
619
620     return gv;
621 }
622
623 /*
624 =for apidoc gv_fetchmeth
625
626 Like L</gv_fetchmeth_pvn>, but lacks a flags parameter.
627
628 =for apidoc gv_fetchmeth_sv
629
630 Exactly like L</gv_fetchmeth_pvn>, but takes the name string in the form
631 of an SV instead of a string/length pair.
632
633 =cut
634 */
635
636 GV *
637 Perl_gv_fetchmeth_sv(pTHX_ HV *stash, SV *namesv, I32 level, U32 flags)
638 {
639     char *namepv;
640     STRLEN namelen;
641     PERL_ARGS_ASSERT_GV_FETCHMETH_SV;
642     if (LIKELY(SvPOK_nog(namesv))) /* common case */
643         return gv_fetchmeth_internal(stash, namesv, NULL, 0, level, flags);
644     namepv = SvPV(namesv, namelen);
645     if (SvUTF8(namesv)) flags |= SVf_UTF8;
646     return gv_fetchmeth_pvn(stash, namepv, namelen, level, flags);
647 }
648
649 /*
650 =for apidoc gv_fetchmeth_pv
651
652 Exactly like L</gv_fetchmeth_pvn>, but takes a nul-terminated string 
653 instead of a string/length pair.
654
655 =cut
656 */
657
658 GV *
659 Perl_gv_fetchmeth_pv(pTHX_ HV *stash, const char *name, I32 level, U32 flags)
660 {
661     PERL_ARGS_ASSERT_GV_FETCHMETH_PV;
662     return gv_fetchmeth_internal(stash, NULL, name, strlen(name), level, flags);
663 }
664
665 /*
666 =for apidoc gv_fetchmeth_pvn
667
668 Returns the glob with the given C<name> and a defined subroutine or
669 C<NULL>.  The glob lives in the given C<stash>, or in the stashes
670 accessible via @ISA and UNIVERSAL::.
671
672 The argument C<level> should be either 0 or -1.  If C<level==0>, as a
673 side-effect creates a glob with the given C<name> in the given C<stash>
674 which in the case of success contains an alias for the subroutine, and sets
675 up caching info for this glob.
676
677 The only significant values for C<flags> are GV_SUPER and SVf_UTF8.
678
679 GV_SUPER indicates that we want to look up the method in the superclasses
680 of the C<stash>.
681
682 The
683 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
684 visible to Perl code.  So when calling C<call_sv>, you should not use
685 the GV directly; instead, you should use the method's CV, which can be
686 obtained from the GV with the C<GvCV> macro.
687
688 =cut
689 */
690
691 /* NOTE: No support for tied ISA */
692
693 PERL_STATIC_INLINE GV*
694 S_gv_fetchmeth_internal(pTHX_ HV* stash, SV* meth, const char* name, STRLEN len, I32 level, U32 flags)
695 {
696     GV** gvp;
697     HE* he;
698     AV* linear_av;
699     SV** linear_svp;
700     SV* linear_sv;
701     HV* cstash, *cachestash;
702     GV* candidate = NULL;
703     CV* cand_cv = NULL;
704     GV* topgv = NULL;
705     const char *hvname;
706     I32 create = (level >= 0) ? HV_FETCH_LVALUE : 0;
707     I32 items;
708     U32 topgen_cmp;
709     U32 is_utf8 = flags & SVf_UTF8;
710
711     /* UNIVERSAL methods should be callable without a stash */
712     if (!stash) {
713         create = 0;  /* probably appropriate */
714         if(!(stash = gv_stashpvs("UNIVERSAL", 0)))
715             return 0;
716     }
717
718     assert(stash);
719
720     hvname = HvNAME_get(stash);
721     if (!hvname)
722       Perl_croak(aTHX_ "Can't use anonymous symbol table for method lookup");
723
724     assert(hvname);
725     assert(name || meth);
726
727     DEBUG_o( Perl_deb(aTHX_ "Looking for %smethod %s in package %s\n",
728                       flags & GV_SUPER ? "SUPER " : "",
729                       name ? name : SvPV_nolen(meth), hvname) );
730
731     topgen_cmp = HvMROMETA(stash)->cache_gen + PL_sub_generation;
732
733     if (flags & GV_SUPER) {
734         if (!HvAUX(stash)->xhv_mro_meta->super)
735             HvAUX(stash)->xhv_mro_meta->super = newHV();
736         cachestash = HvAUX(stash)->xhv_mro_meta->super;
737     }
738     else cachestash = stash;
739
740     /* check locally for a real method or a cache entry */
741     he = (HE*)hv_common(
742         cachestash, meth, name, len, (flags & SVf_UTF8) ? HVhek_UTF8 : 0, create, NULL, 0
743     );
744     if (he) gvp = (GV**)&HeVAL(he);
745     else gvp = NULL;
746
747     if(gvp) {
748         topgv = *gvp;
749       have_gv:
750         assert(topgv);
751         if (SvTYPE(topgv) != SVt_PVGV)
752         {
753             if (!name)
754                 name = SvPV_nomg(meth, len);
755             gv_init_pvn(topgv, stash, name, len, GV_ADDMULTI|is_utf8);
756         }
757         if ((cand_cv = GvCV(topgv))) {
758             /* If genuine method or valid cache entry, use it */
759             if (!GvCVGEN(topgv) || GvCVGEN(topgv) == topgen_cmp) {
760                 return topgv;
761             }
762             else {
763                 /* stale cache entry, junk it and move on */
764                 SvREFCNT_dec_NN(cand_cv);
765                 GvCV_set(topgv, NULL);
766                 cand_cv = NULL;
767                 GvCVGEN(topgv) = 0;
768             }
769         }
770         else if (GvCVGEN(topgv) == topgen_cmp) {
771             /* cache indicates no such method definitively */
772             return 0;
773         }
774         else if (stash == cachestash
775               && len > 1 /* shortest is uc */ && HvNAMELEN_get(stash) == 4
776               && strnEQ(hvname, "CORE", 4)
777               && S_maybe_add_coresub(aTHX_ NULL,topgv,name,len))
778             goto have_gv;
779     }
780
781     linear_av = mro_get_linear_isa(stash); /* has ourselves at the top of the list */
782     linear_svp = AvARRAY(linear_av) + 1; /* skip over self */
783     items = AvFILLp(linear_av); /* no +1, to skip over self */
784     while (items--) {
785         linear_sv = *linear_svp++;
786         assert(linear_sv);
787         cstash = gv_stashsv(linear_sv, 0);
788
789         if (!cstash) {
790             Perl_ck_warner(aTHX_ packWARN(WARN_SYNTAX),
791                            "Can't locate package %"SVf" for @%"HEKf"::ISA",
792                            SVfARG(linear_sv),
793                            HEKfARG(HvNAME_HEK(stash)));
794             continue;
795         }
796
797         assert(cstash);
798
799         gvp = (GV**)hv_fetch(cstash, name, is_utf8 ? -(I32)len : (I32)len, 0);
800         if (!gvp) {
801             if (len > 1 && HvNAMELEN_get(cstash) == 4) {
802                 const char *hvname = HvNAME(cstash); assert(hvname);
803                 if (strnEQ(hvname, "CORE", 4)
804                  && (candidate =
805                       S_maybe_add_coresub(aTHX_ cstash,NULL,name,len)
806                     ))
807                     goto have_candidate;
808             }
809             continue;
810         }
811         else candidate = *gvp;
812        have_candidate:
813         assert(candidate);
814         if (SvTYPE(candidate) != SVt_PVGV)
815             gv_init_pvn(candidate, cstash, name, len, GV_ADDMULTI|is_utf8);
816         if (SvTYPE(candidate) == SVt_PVGV && (cand_cv = GvCV(candidate)) && !GvCVGEN(candidate)) {
817             /*
818              * Found real method, cache method in topgv if:
819              *  1. topgv has no synonyms (else inheritance crosses wires)
820              *  2. method isn't a stub (else AUTOLOAD fails spectacularly)
821              */
822             if (topgv && (GvREFCNT(topgv) == 1) && (CvROOT(cand_cv) || CvXSUB(cand_cv))) {
823                   CV *old_cv = GvCV(topgv);
824                   SvREFCNT_dec(old_cv);
825                   SvREFCNT_inc_simple_void_NN(cand_cv);
826                   GvCV_set(topgv, cand_cv);
827                   GvCVGEN(topgv) = topgen_cmp;
828             }
829             return candidate;
830         }
831     }
832
833     /* Check UNIVERSAL without caching */
834     if(level == 0 || level == -1) {
835         candidate = gv_fetchmeth_internal(NULL, meth, name, len, 1,
836                                           flags &~GV_SUPER);
837         if(candidate) {
838             cand_cv = GvCV(candidate);
839             if (topgv && (GvREFCNT(topgv) == 1) && (CvROOT(cand_cv) || CvXSUB(cand_cv))) {
840                   CV *old_cv = GvCV(topgv);
841                   SvREFCNT_dec(old_cv);
842                   SvREFCNT_inc_simple_void_NN(cand_cv);
843                   GvCV_set(topgv, cand_cv);
844                   GvCVGEN(topgv) = topgen_cmp;
845             }
846             return candidate;
847         }
848     }
849
850     if (topgv && GvREFCNT(topgv) == 1) {
851         /* cache the fact that the method is not defined */
852         GvCVGEN(topgv) = topgen_cmp;
853     }
854
855     return 0;
856 }
857
858 GV *
859 Perl_gv_fetchmeth_pvn(pTHX_ HV *stash, const char *name, STRLEN len, I32 level, U32 flags)
860 {
861     PERL_ARGS_ASSERT_GV_FETCHMETH_PVN;
862     return gv_fetchmeth_internal(stash, NULL, name, len, level, flags);
863 }
864
865 /*
866 =for apidoc gv_fetchmeth_autoload
867
868 This is the old form of L</gv_fetchmeth_pvn_autoload>, which has no flags
869 parameter.
870
871 =for apidoc gv_fetchmeth_sv_autoload
872
873 Exactly like L</gv_fetchmeth_pvn_autoload>, but takes the name string in the form
874 of an SV instead of a string/length pair.
875
876 =cut
877 */
878
879 GV *
880 Perl_gv_fetchmeth_sv_autoload(pTHX_ HV *stash, SV *namesv, I32 level, U32 flags)
881 {
882    char *namepv;
883    STRLEN namelen;
884    PERL_ARGS_ASSERT_GV_FETCHMETH_SV_AUTOLOAD;
885    namepv = SvPV(namesv, namelen);
886    if (SvUTF8(namesv))
887        flags |= SVf_UTF8;
888    return gv_fetchmeth_pvn_autoload(stash, namepv, namelen, level, flags);
889 }
890
891 /*
892 =for apidoc gv_fetchmeth_pv_autoload
893
894 Exactly like L</gv_fetchmeth_pvn_autoload>, but takes a nul-terminated string
895 instead of a string/length pair.
896
897 =cut
898 */
899
900 GV *
901 Perl_gv_fetchmeth_pv_autoload(pTHX_ HV *stash, const char *name, I32 level, U32 flags)
902 {
903     PERL_ARGS_ASSERT_GV_FETCHMETH_PV_AUTOLOAD;
904     return gv_fetchmeth_pvn_autoload(stash, name, strlen(name), level, flags);
905 }
906
907 /*
908 =for apidoc gv_fetchmeth_pvn_autoload
909
910 Same as gv_fetchmeth_pvn(), but looks for autoloaded subroutines too.
911 Returns a glob for the subroutine.
912
913 For an autoloaded subroutine without a GV, will create a GV even
914 if C<level < 0>.  For an autoloaded subroutine without a stub, GvCV()
915 of the result may be zero.
916
917 Currently, the only significant value for C<flags> is SVf_UTF8.
918
919 =cut
920 */
921
922 GV *
923 Perl_gv_fetchmeth_pvn_autoload(pTHX_ HV *stash, const char *name, STRLEN len, I32 level, U32 flags)
924 {
925     GV *gv = gv_fetchmeth_pvn(stash, name, len, level, flags);
926
927     PERL_ARGS_ASSERT_GV_FETCHMETH_PVN_AUTOLOAD;
928
929     if (!gv) {
930         CV *cv;
931         GV **gvp;
932
933         if (!stash)
934             return NULL;        /* UNIVERSAL::AUTOLOAD could cause trouble */
935         if (len == S_autolen && memEQ(name, S_autoload, S_autolen))
936             return NULL;
937         if (!(gv = gv_fetchmeth_pvn(stash, S_autoload, S_autolen, FALSE, flags)))
938             return NULL;
939         cv = GvCV(gv);
940         if (!(CvROOT(cv) || CvXSUB(cv)))
941             return NULL;
942         /* Have an autoload */
943         if (level < 0)  /* Cannot do without a stub */
944             gv_fetchmeth_pvn(stash, name, len, 0, flags);
945         gvp = (GV**)hv_fetch(stash, name,
946                         (flags & SVf_UTF8) ? -(I32)len : (I32)len, (level >= 0));
947         if (!gvp)
948             return NULL;
949         return *gvp;
950     }
951     return gv;
952 }
953
954 /*
955 =for apidoc gv_fetchmethod_autoload
956
957 Returns the glob which contains the subroutine to call to invoke the method
958 on the C<stash>.  In fact in the presence of autoloading this may be the
959 glob for "AUTOLOAD".  In this case the corresponding variable $AUTOLOAD is
960 already setup.
961
962 The third parameter of C<gv_fetchmethod_autoload> determines whether
963 AUTOLOAD lookup is performed if the given method is not present: non-zero
964 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
965 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
966 with a non-zero C<autoload> parameter.
967
968 These functions grant C<"SUPER"> token
969 as a prefix of the method name.  Note
970 that if you want to keep the returned glob for a long time, you need to
971 check for it being "AUTOLOAD", since at the later time the call may load a
972 different subroutine due to $AUTOLOAD changing its value.  Use the glob
973 created as a side effect to do this.
974
975 These functions have the same side-effects as C<gv_fetchmeth> with
976 C<level==0>.  The warning against passing the GV returned by
977 C<gv_fetchmeth> to C<call_sv> applies equally to these functions.
978
979 =cut
980 */
981
982 GV *
983 Perl_gv_fetchmethod_autoload(pTHX_ HV *stash, const char *name, I32 autoload)
984 {
985     PERL_ARGS_ASSERT_GV_FETCHMETHOD_AUTOLOAD;
986
987     return gv_fetchmethod_flags(stash, name, autoload ? GV_AUTOLOAD : 0);
988 }
989
990 GV *
991 Perl_gv_fetchmethod_sv_flags(pTHX_ HV *stash, SV *namesv, U32 flags)
992 {
993     char *namepv;
994     STRLEN namelen;
995     PERL_ARGS_ASSERT_GV_FETCHMETHOD_SV_FLAGS;
996     namepv = SvPV(namesv, namelen);
997     if (SvUTF8(namesv))
998        flags |= SVf_UTF8;
999     return gv_fetchmethod_pvn_flags(stash, namepv, namelen, flags);
1000 }
1001
1002 GV *
1003 Perl_gv_fetchmethod_pv_flags(pTHX_ HV *stash, const char *name, U32 flags)
1004 {
1005     PERL_ARGS_ASSERT_GV_FETCHMETHOD_PV_FLAGS;
1006     return gv_fetchmethod_pvn_flags(stash, name, strlen(name), flags);
1007 }
1008
1009 /* Don't merge this yet, as it's likely to get a len parameter, and possibly
1010    even a U32 hash */
1011 GV *
1012 Perl_gv_fetchmethod_pvn_flags(pTHX_ HV *stash, const char *name, const STRLEN len, U32 flags)
1013 {
1014     const char *nend;
1015     const char *nsplit = NULL;
1016     GV* gv;
1017     HV* ostash = stash;
1018     const char * const origname = name;
1019     SV *const error_report = MUTABLE_SV(stash);
1020     const U32 autoload = flags & GV_AUTOLOAD;
1021     const U32 do_croak = flags & GV_CROAK;
1022     const U32 is_utf8  = flags & SVf_UTF8;
1023
1024     PERL_ARGS_ASSERT_GV_FETCHMETHOD_PVN_FLAGS;
1025
1026     if (SvTYPE(stash) < SVt_PVHV)
1027         stash = NULL;
1028     else {
1029         /* The only way stash can become NULL later on is if nsplit is set,
1030            which in turn means that there is no need for a SVt_PVHV case
1031            the error reporting code.  */
1032     }
1033
1034     for (nend = name; *nend || nend != (origname + len); nend++) {
1035         if (*nend == '\'') {
1036             nsplit = nend;
1037             name = nend + 1;
1038         }
1039         else if (*nend == ':' && *(nend + 1) == ':') {
1040             nsplit = nend++;
1041             name = nend + 1;
1042         }
1043     }
1044     if (nsplit) {
1045         if ((nsplit - origname) == 5 && memEQ(origname, "SUPER", 5)) {
1046             /* ->SUPER::method should really be looked up in original stash */
1047             stash = CopSTASH(PL_curcop);
1048             flags |= GV_SUPER;
1049             DEBUG_o( Perl_deb(aTHX_ "Treating %s as %s::%s\n",
1050                          origname, HvENAME_get(stash), name) );
1051         }
1052         else if ((nsplit - origname) >= 7 &&
1053                  strnEQ(nsplit - 7, "::SUPER", 7)) {
1054             /* don't autovifify if ->NoSuchStash::SUPER::method */
1055             stash = gv_stashpvn(origname, nsplit - origname - 7, is_utf8);
1056             if (stash) flags |= GV_SUPER;
1057         }
1058         else {
1059             /* don't autovifify if ->NoSuchStash::method */
1060             stash = gv_stashpvn(origname, nsplit - origname, is_utf8);
1061         }
1062         ostash = stash;
1063     }
1064
1065     gv = gv_fetchmeth_pvn(stash, name, nend - name, 0, flags);
1066     if (!gv) {
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 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 GV_ADD and 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)
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<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 C<gv_stashpvn>.
1496
1497 Note this interface is strongly preferred over C<gv_stashpvn> for performance reasons.
1498
1499 =cut
1500 */
1501
1502 HV*
1503 Perl_gv_stashsv(pTHX_ SV *sv, I32 flags)
1504 {
1505     PERL_ARGS_ASSERT_GV_STASHSV;
1506     return gv_stashsvpvn_cached(sv, NULL, 0, flags);
1507 }
1508
1509
1510 GV *
1511 Perl_gv_fetchpv(pTHX_ const char *nambeg, I32 add, const svtype sv_type) {
1512     PERL_ARGS_ASSERT_GV_FETCHPV;
1513     return gv_fetchpvn_flags(nambeg, strlen(nambeg), add, sv_type);
1514 }
1515
1516 GV *
1517 Perl_gv_fetchsv(pTHX_ SV *name, I32 flags, const svtype sv_type) {
1518     STRLEN len;
1519     const char * const nambeg =
1520        SvPV_flags_const(name, len, flags & GV_NO_SVGMAGIC ? 0 : SV_GMAGIC);
1521     PERL_ARGS_ASSERT_GV_FETCHSV;
1522     return gv_fetchpvn_flags(nambeg, len, flags | SvUTF8(name), sv_type);
1523 }
1524
1525 PERL_STATIC_INLINE void
1526 S_gv_magicalize_isa(pTHX_ GV *gv)
1527 {
1528     AV* av;
1529
1530     PERL_ARGS_ASSERT_GV_MAGICALIZE_ISA;
1531
1532     av = GvAVn(gv);
1533     GvMULTI_on(gv);
1534     sv_magic(MUTABLE_SV(av), MUTABLE_SV(gv), PERL_MAGIC_isa,
1535              NULL, 0);
1536 }
1537
1538 /* This function grabs name and tries to split a stash and glob
1539  * from its contents. TODO better description, comments
1540  * 
1541  * If the function returns TRUE and 'name == name_end', then
1542  * 'gv' can be directly returned to the caller of gv_fetchpvn_flags
1543  */
1544 PERL_STATIC_INLINE bool
1545 S_parse_gv_stash_name(pTHX_ HV **stash, GV **gv, const char **name,
1546                STRLEN *len, const char *nambeg, STRLEN full_len,
1547                const U32 is_utf8, const I32 add)
1548 {
1549     const char *name_cursor;
1550     const char *const name_end = nambeg + full_len;
1551     const char *const name_em1 = name_end - 1;
1552
1553     PERL_ARGS_ASSERT_PARSE_GV_STASH_NAME;
1554     
1555     if (full_len > 2 && **name == '*' && isIDFIRST_lazy_if(*name + 1, is_utf8)) {
1556         /* accidental stringify on a GV? */
1557         (*name)++;
1558     }
1559
1560     for (name_cursor = *name; name_cursor < name_end; name_cursor++) {
1561         if (name_cursor < name_em1 &&
1562             ((*name_cursor == ':' && name_cursor[1] == ':')
1563            || *name_cursor == '\''))
1564         {
1565             if (!*stash)
1566                 *stash = PL_defstash;
1567             if (!*stash || !SvREFCNT(*stash)) /* symbol table under destruction */
1568                 return FALSE;
1569
1570             *len = name_cursor - *name;
1571             if (name_cursor > nambeg) { /* Skip for initial :: or ' */
1572                 const char *key;
1573                 GV**gvp;
1574                 if (*name_cursor == ':') {
1575                     key = *name;
1576                     *len += 2;
1577                 }
1578                 else {
1579                     char *tmpbuf;
1580                     Newx(tmpbuf, *len+2, char);
1581                     Copy(*name, tmpbuf, *len, char);
1582                     tmpbuf[(*len)++] = ':';
1583                     tmpbuf[(*len)++] = ':';
1584                     key = tmpbuf;
1585                 }
1586                 gvp = (GV**)hv_fetch(*stash, key, is_utf8 ? -((I32)*len) : (I32)*len, add);
1587                 *gv = gvp ? *gvp : NULL;
1588                 if (*gv && *gv != (const GV *)&PL_sv_undef) {
1589                     if (SvTYPE(*gv) != SVt_PVGV)
1590                         gv_init_pvn(*gv, *stash, key, *len, (add & GV_ADDMULTI)|is_utf8);
1591                     else
1592                         GvMULTI_on(*gv);
1593                 }
1594                 if (key != *name)
1595                     Safefree(key);
1596                 if (!*gv || *gv == (const GV *)&PL_sv_undef)
1597                     return FALSE;
1598
1599                 if (!(*stash = GvHV(*gv))) {
1600                     *stash = GvHV(*gv) = newHV();
1601                     if (!HvNAME_get(*stash)) {
1602                         if (GvSTASH(*gv) == PL_defstash && *len == 6
1603                             && strnEQ(*name, "CORE", 4))
1604                             hv_name_set(*stash, "CORE", 4, 0);
1605                         else
1606                             hv_name_set(
1607                                 *stash, nambeg, name_cursor-nambeg, is_utf8
1608                             );
1609                     /* If the containing stash has multiple effective
1610                     names, see that this one gets them, too. */
1611                     if (HvAUX(GvSTASH(*gv))->xhv_name_count)
1612                         mro_package_moved(*stash, NULL, *gv, 1);
1613                     }
1614                 }
1615                 else if (!HvNAME_get(*stash))
1616                     hv_name_set(*stash, nambeg, name_cursor - nambeg, is_utf8);
1617             }
1618
1619             if (*name_cursor == ':')
1620                 name_cursor++;
1621             *name = name_cursor+1;
1622             if (*name == name_end) {
1623                 if (!*gv)
1624                     *gv = MUTABLE_GV(*hv_fetchs(PL_defstash, "main::", TRUE));
1625                 return TRUE;
1626             }
1627         }
1628     }
1629     *len = name_cursor - *name;
1630     return TRUE;
1631 }
1632
1633 /* Checks if an unqualified name is in the main stash */
1634 PERL_STATIC_INLINE bool
1635 S_gv_is_in_main(pTHX_ const char *name, STRLEN len, const U32 is_utf8)
1636 {
1637     PERL_ARGS_ASSERT_GV_IS_IN_MAIN;
1638     
1639     /* If it's an alphanumeric variable */
1640     if ( len && isIDFIRST_lazy_if(name, is_utf8) ) {
1641         /* Some "normal" variables are always in main::,
1642          * like INC or STDOUT.
1643          */
1644         switch (len) {
1645             case 1:
1646             if (*name == '_')
1647                 return TRUE;
1648             break;
1649             case 3:
1650             if ((name[0] == 'I' && name[1] == 'N' && name[2] == 'C')
1651                 || (name[0] == 'E' && name[1] == 'N' && name[2] == 'V')
1652                 || (name[0] == 'S' && name[1] == 'I' && name[2] == 'G'))
1653                 return TRUE;
1654             break;
1655             case 4:
1656             if (name[0] == 'A' && name[1] == 'R' && name[2] == 'G'
1657                 && name[3] == 'V')
1658                 return TRUE;
1659             break;
1660             case 5:
1661             if (name[0] == 'S' && name[1] == 'T' && name[2] == 'D'
1662                 && name[3] == 'I' && name[4] == 'N')
1663                 return TRUE;
1664             break;
1665             case 6:
1666             if ((name[0] == 'S' && name[1] == 'T' && name[2] == 'D')
1667                 &&((name[3] == 'O' && name[4] == 'U' && name[5] == 'T')
1668                     ||(name[3] == 'E' && name[4] == 'R' && name[5] == 'R')))
1669                 return TRUE;
1670             break;
1671             case 7:
1672             if (name[0] == 'A' && name[1] == 'R' && name[2] == 'G'
1673                 && name[3] == 'V' && name[4] == 'O' && name[5] == 'U'
1674                 && name[6] == 'T')
1675                 return TRUE;
1676             break;
1677         }
1678     }
1679     /* *{""}, or a special variable like $@ */
1680     else
1681         return TRUE;
1682     
1683     return FALSE;
1684 }
1685
1686
1687 /* This function is called if parse_gv_stash_name() failed to
1688  * find a stash, or if GV_NOTQUAL or an empty name was passed
1689  * to gv_fetchpvn_flags.
1690  * 
1691  * It returns FALSE if the default stash can't be found nor created,
1692  * which might happen during global destruction.
1693  */
1694 PERL_STATIC_INLINE bool
1695 S_find_default_stash(pTHX_ HV **stash, const char *name, STRLEN len,
1696                const U32 is_utf8, const I32 add,
1697                const svtype sv_type)
1698 {
1699     PERL_ARGS_ASSERT_FIND_DEFAULT_STASH;
1700     
1701     /* No stash in name, so see how we can default */
1702
1703     if ( gv_is_in_main(name, len, is_utf8) ) {
1704         *stash = PL_defstash;
1705     }
1706     else {
1707         if (IN_PERL_COMPILETIME) {
1708             *stash = PL_curstash;
1709             if (add && (PL_hints & HINT_STRICT_VARS) &&
1710                 sv_type != SVt_PVCV &&
1711                 sv_type != SVt_PVGV &&
1712                 sv_type != SVt_PVFM &&
1713                 sv_type != SVt_PVIO &&
1714                 !(len == 1 && sv_type == SVt_PV &&
1715                 (*name == 'a' || *name == 'b')) )
1716             {
1717                 GV**gvp = (GV**)hv_fetch(*stash,name,is_utf8 ? -(I32)len : (I32)len,0);
1718                 if (!gvp || *gvp == (const GV *)&PL_sv_undef ||
1719                     SvTYPE(*gvp) != SVt_PVGV)
1720                 {
1721                     *stash = NULL;
1722                 }
1723                 else if ((sv_type == SVt_PV   && !GvIMPORTED_SV(*gvp)) ||
1724                          (sv_type == SVt_PVAV && !GvIMPORTED_AV(*gvp)) ||
1725                          (sv_type == SVt_PVHV && !GvIMPORTED_HV(*gvp)) )
1726                 {
1727                     /* diag_listed_as: Variable "%s" is not imported%s */
1728                     Perl_ck_warner_d(
1729                         aTHX_ packWARN(WARN_MISC),
1730                         "Variable \"%c%"UTF8f"\" is not imported",
1731                         sv_type == SVt_PVAV ? '@' :
1732                         sv_type == SVt_PVHV ? '%' : '$',
1733                         UTF8fARG(is_utf8, len, name));
1734                     if (GvCVu(*gvp))
1735                         Perl_ck_warner_d(
1736                             aTHX_ packWARN(WARN_MISC),
1737                             "\t(Did you mean &%"UTF8f" instead?)\n",
1738                             UTF8fARG(is_utf8, len, name)
1739                         );
1740                     *stash = NULL;
1741                 }
1742             }
1743         }
1744         else {
1745             /* Use the current op's stash */
1746             *stash = CopSTASH(PL_curcop);
1747         }
1748     }
1749
1750     if (!*stash) {
1751         if (add && !PL_in_clean_all) {
1752             GV *gv;
1753             qerror(Perl_mess(aTHX_
1754                  "Global symbol \"%s%"UTF8f
1755                  "\" requires explicit package name (did you forget to "
1756                  "declare \"my %s%"UTF8f"\"?)",
1757                  (sv_type == SVt_PV ? "$"
1758                   : sv_type == SVt_PVAV ? "@"
1759                   : sv_type == SVt_PVHV ? "%"
1760                   : ""), UTF8fARG(is_utf8, len, name),
1761                  (sv_type == SVt_PV ? "$"
1762                   : sv_type == SVt_PVAV ? "@"
1763                   : sv_type == SVt_PVHV ? "%"
1764                   : ""), UTF8fARG(is_utf8, len, name)));
1765             /* To maintain the output of errors after the strict exception
1766              * above, and to keep compat with older releases, rather than
1767              * placing the variables in the pad, we place
1768              * them in the <none>:: stash.
1769              */
1770             gv = gv_fetchpvs("<none>::", GV_ADDMULTI, SVt_PVHV);
1771             if (!gv) {
1772                 /* symbol table under destruction */
1773                 return FALSE;
1774             }
1775             *stash = GvHV(gv);
1776         }
1777         else
1778             return FALSE;
1779     }
1780
1781     if (!SvREFCNT(*stash))   /* symbol table under destruction */
1782         return FALSE;
1783
1784     return TRUE;
1785 }
1786
1787 /* gv_magicalize only turns on the SVf_READONLY flag, not SVf_PROTECT.  So
1788    redefine SvREADONLY_on for that purpose.  We don’t use it later on in
1789    this file.  */
1790 #undef SvREADONLY_on
1791 #define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
1792
1793 /* gv_magicalize() is called by gv_fetchpvn_flags when creating
1794  * a new GV.
1795  * Note that it does not insert the GV into the stash prior to
1796  * magicalization, which some variables require need in order
1797  * to work (like $[, %+, %-, %!), so callers must take care of
1798  * that beforehand.
1799  * 
1800  * The return value has a specific meaning for gv_fetchpvn_flags:
1801  * If it returns true, and the gv is empty, it indicates that its
1802  * refcount should be decreased.
1803  */
1804 PERL_STATIC_INLINE bool
1805 S_gv_magicalize(pTHX_ GV *gv, HV *stash, const char *name, STRLEN len,
1806                bool addmg, const svtype sv_type)
1807 {
1808     SSize_t paren;
1809
1810     PERL_ARGS_ASSERT_GV_MAGICALIZE;
1811     
1812     if (stash != PL_defstash) { /* not the main stash */
1813         /* We only have to check for a few names here: a, b, EXPORT, ISA
1814            and VERSION. All the others apply only to the main stash or to
1815            CORE (which is checked right after this). */
1816         if (len) {
1817             const char * const name2 = name + 1;
1818             switch (*name) {
1819             case 'E':
1820                 if (strnEQ(name2, "XPORT", 5))
1821                     GvMULTI_on(gv);
1822                 break;
1823             case 'I':
1824                 if (strEQ(name2, "SA"))
1825                     gv_magicalize_isa(gv);
1826                 break;
1827             case 'V':
1828                 if (strEQ(name2, "ERSION"))
1829                     GvMULTI_on(gv);
1830                 break;
1831             case 'a':
1832             case 'b':
1833                 if (len == 1 && sv_type == SVt_PV)
1834                     GvMULTI_on(gv);
1835                 /* FALLTHROUGH */
1836             default:
1837                 goto try_core;
1838             }
1839             return addmg;
1840         }
1841       try_core:
1842         if (len > 1 /* shortest is uc */ && HvNAMELEN_get(stash) == 4) {
1843           /* Avoid null warning: */
1844           const char * const stashname = HvNAME(stash); assert(stashname);
1845           if (strnEQ(stashname, "CORE", 4))
1846             S_maybe_add_coresub(aTHX_ 0, gv, name, len);
1847         }
1848     }
1849     else if (len > 1) {
1850 #ifndef EBCDIC
1851         if (*name > 'V' ) {
1852             NOOP;
1853             /* Nothing else to do.
1854                The compiler will probably turn the switch statement into a
1855                branch table. Make sure we avoid even that small overhead for
1856                the common case of lower case variable names.  (On EBCDIC
1857                platforms, we can't just do:
1858                  if (NATIVE_TO_ASCII(*name) > NATIVE_TO_ASCII('V') ) {
1859                because cases like '\027' in the switch statement below are
1860                C1 (non-ASCII) controls on those platforms, so the remapping
1861                would make them larger than 'V')
1862              */
1863         } else
1864 #endif
1865         {
1866             const char * name2 = name + 1;
1867             switch (*name) {
1868             case 'A':
1869                 if (strEQ(name2, "RGV")) {
1870                     IoFLAGS(GvIOn(gv)) |= IOf_ARGV|IOf_START;
1871                 }
1872                 else if (strEQ(name2, "RGVOUT")) {
1873                     GvMULTI_on(gv);
1874                 }
1875                 break;
1876             case 'E':
1877                 if (strnEQ(name2, "XPORT", 5))
1878                     GvMULTI_on(gv);
1879                 break;
1880             case 'I':
1881                 if (strEQ(name2, "SA")) {
1882                     gv_magicalize_isa(gv);
1883                 }
1884                 break;
1885             case 'S':
1886                 if (strEQ(name2, "IG")) {
1887                     HV *hv;
1888                     I32 i;
1889                     if (!PL_psig_name) {
1890                         Newxz(PL_psig_name, 2 * SIG_SIZE, SV*);
1891                         Newxz(PL_psig_pend, SIG_SIZE, int);
1892                         PL_psig_ptr = PL_psig_name + SIG_SIZE;
1893                     } else {
1894                         /* I think that the only way to get here is to re-use an
1895                            embedded perl interpreter, where the previous
1896                            use didn't clean up fully because
1897                            PL_perl_destruct_level was 0. I'm not sure that we
1898                            "support" that, in that I suspect in that scenario
1899                            there are sufficient other garbage values left in the
1900                            interpreter structure that something else will crash
1901                            before we get here. I suspect that this is one of
1902                            those "doctor, it hurts when I do this" bugs.  */
1903                         Zero(PL_psig_name, 2 * SIG_SIZE, SV*);
1904                         Zero(PL_psig_pend, SIG_SIZE, int);
1905                     }
1906                     GvMULTI_on(gv);
1907                     hv = GvHVn(gv);
1908                     hv_magic(hv, NULL, PERL_MAGIC_sig);
1909                     for (i = 1; i < SIG_SIZE; i++) {
1910                         SV * const * const init = hv_fetch(hv, PL_sig_name[i], strlen(PL_sig_name[i]), 1);
1911                         if (init)
1912                             sv_setsv(*init, &PL_sv_undef);
1913                     }
1914                 }
1915                 break;
1916             case 'V':
1917                 if (strEQ(name2, "ERSION"))
1918                     GvMULTI_on(gv);
1919                 break;
1920             case '\003':        /* $^CHILD_ERROR_NATIVE */
1921                 if (strEQ(name2, "HILD_ERROR_NATIVE"))
1922                     goto magicalize;
1923                 break;
1924             case '\005':        /* $^ENCODING */
1925                 if (*name2 == '_') {
1926                     name2++;
1927                 }
1928                 if (strEQ(name2, "NCODING"))
1929                     goto magicalize;
1930                 break;
1931             case '\007':        /* $^GLOBAL_PHASE */
1932                 if (strEQ(name2, "LOBAL_PHASE"))
1933                     goto ro_magicalize;
1934                 break;
1935             case '\014':        /* $^LAST_FH */
1936                 if (strEQ(name2, "AST_FH"))
1937                     goto ro_magicalize;
1938                 break;
1939             case '\015':        /* $^MATCH */
1940                 if (strEQ(name2, "ATCH")) {
1941                     paren = RX_BUFF_IDX_CARET_FULLMATCH;
1942                     goto storeparen;
1943                 }
1944                 break;
1945             case '\017':        /* $^OPEN */
1946                 if (strEQ(name2, "PEN"))
1947                     goto magicalize;
1948                 break;
1949             case '\020':        /* $^PREMATCH  $^POSTMATCH */
1950                 if (strEQ(name2, "REMATCH")) {
1951                     paren = RX_BUFF_IDX_CARET_PREMATCH;
1952                     goto storeparen;
1953                 }
1954                 if (strEQ(name2, "OSTMATCH")) {
1955                     paren = RX_BUFF_IDX_CARET_POSTMATCH;
1956                     goto storeparen;
1957                 }
1958                 break;
1959             case '\024':        /* ${^TAINT} */
1960                 if (strEQ(name2, "AINT"))
1961                     goto ro_magicalize;
1962                 break;
1963             case '\025':        /* ${^UNICODE}, ${^UTF8LOCALE} */
1964                 if (strEQ(name2, "NICODE"))
1965                     goto ro_magicalize;
1966                 if (strEQ(name2, "TF8LOCALE"))
1967                     goto ro_magicalize;
1968                 if (strEQ(name2, "TF8CACHE"))
1969                     goto magicalize;
1970                 break;
1971             case '\027':        /* $^WARNING_BITS */
1972                 if (strEQ(name2, "ARNING_BITS"))
1973                     goto magicalize;
1974                 break;
1975             case '1':
1976             case '2':
1977             case '3':
1978             case '4':
1979             case '5':
1980             case '6':
1981             case '7':
1982             case '8':
1983             case '9':
1984             {
1985                 /* Ensures that we have an all-digit variable, ${"1foo"} fails
1986                    this test  */
1987                 /* This snippet is taken from is_gv_magical */
1988                 const char *end = name + len;
1989                 while (--end > name) {
1990                     if (!isDIGIT(*end))
1991                         return addmg;
1992                 }
1993                 paren = grok_atou(name, NULL);
1994                 goto storeparen;
1995             }
1996             }
1997         }
1998     } else {
1999         /* Names of length 1.  (Or 0. But name is NUL terminated, so that will
2000            be case '\0' in this switch statement (ie a default case)  */
2001         switch (*name) {
2002         case '&':               /* $& */
2003             paren = RX_BUFF_IDX_FULLMATCH;
2004             goto sawampersand;
2005         case '`':               /* $` */
2006             paren = RX_BUFF_IDX_PREMATCH;
2007             goto sawampersand;
2008         case '\'':              /* $' */
2009             paren = RX_BUFF_IDX_POSTMATCH;
2010         sawampersand:
2011 #ifdef PERL_SAWAMPERSAND
2012             if (!(
2013                 sv_type == SVt_PVAV ||
2014                 sv_type == SVt_PVHV ||
2015                 sv_type == SVt_PVCV ||
2016                 sv_type == SVt_PVFM ||
2017                 sv_type == SVt_PVIO
2018                 )) { PL_sawampersand |=
2019                         (*name == '`')
2020                             ? SAWAMPERSAND_LEFT
2021                             : (*name == '&')
2022                                 ? SAWAMPERSAND_MIDDLE
2023                                 : SAWAMPERSAND_RIGHT;
2024                 }
2025 #endif
2026             goto storeparen;
2027         case '1':               /* $1 */
2028         case '2':               /* $2 */
2029         case '3':               /* $3 */
2030         case '4':               /* $4 */
2031         case '5':               /* $5 */
2032         case '6':               /* $6 */
2033         case '7':               /* $7 */
2034         case '8':               /* $8 */
2035         case '9':               /* $9 */
2036             paren = *name - '0';
2037
2038         storeparen:
2039             /* Flag the capture variables with a NULL mg_ptr
2040                Use mg_len for the array index to lookup.  */
2041             sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, NULL, paren);
2042             break;
2043
2044         case ':':               /* $: */
2045             sv_setpv(GvSVn(gv),PL_chopset);
2046             goto magicalize;
2047
2048         case '?':               /* $? */
2049 #ifdef COMPLEX_STATUS
2050             SvUPGRADE(GvSVn(gv), SVt_PVLV);
2051 #endif
2052             goto magicalize;
2053
2054         case '!':               /* $! */
2055             GvMULTI_on(gv);
2056             /* If %! has been used, automatically load Errno.pm. */
2057
2058             sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
2059
2060             /* magicalization must be done before require_tie_mod is called */
2061             if (sv_type == SVt_PVHV || sv_type == SVt_PVGV)
2062             {
2063                 require_tie_mod(gv, "!", newSVpvs("Errno"), "TIEHASH", 1);
2064                 addmg = FALSE;
2065             }
2066
2067             break;
2068         case '-':               /* $- */
2069         case '+':               /* $+ */
2070         GvMULTI_on(gv); /* no used once warnings here */
2071         {
2072             AV* const av = GvAVn(gv);
2073             SV* const avc = (*name == '+') ? MUTABLE_SV(av) : NULL;
2074
2075             sv_magic(MUTABLE_SV(av), avc, PERL_MAGIC_regdata, NULL, 0);
2076             sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
2077             if (avc)
2078                 SvREADONLY_on(GvSVn(gv));
2079             SvREADONLY_on(av);
2080
2081             if (sv_type == SVt_PVHV || sv_type == SVt_PVGV)
2082             {
2083                 require_tie_mod(gv, name, newSVpvs("Tie::Hash::NamedCapture"), "TIEHASH", 0);
2084                 addmg = FALSE;
2085             }
2086
2087             break;
2088         }
2089         case '*':               /* $* */
2090         case '#':               /* $# */
2091             if (sv_type == SVt_PV)
2092                 /* diag_listed_as: $* is no longer supported */
2093                 Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_SYNTAX),
2094                                  "$%c is no longer supported", *name);
2095             break;
2096         case '\010':    /* $^H */
2097             {
2098                 HV *const hv = GvHVn(gv);
2099                 hv_magic(hv, NULL, PERL_MAGIC_hints);
2100             }
2101             goto magicalize;
2102         case '[':               /* $[ */
2103             if ((sv_type == SVt_PV || sv_type == SVt_PVGV)
2104              && FEATURE_ARYBASE_IS_ENABLED) {
2105                 require_tie_mod(gv,name,newSVpvs("arybase"),"FETCH",0);
2106                 addmg = FALSE;
2107             }
2108             else goto magicalize;
2109             break;
2110         case '\023':    /* $^S */
2111         ro_magicalize:
2112             SvREADONLY_on(GvSVn(gv));
2113             /* FALLTHROUGH */
2114         case '0':               /* $0 */
2115         case '^':               /* $^ */
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 '\001':    /* $^A */
2129         case '\003':    /* $^C */
2130         case '\004':    /* $^D */
2131         case '\005':    /* $^E */
2132         case '\006':    /* $^F */
2133         case '\011':    /* $^I, NOT \t in EBCDIC */
2134         case '\016':    /* $^N */
2135         case '\017':    /* $^O */
2136         case '\020':    /* $^P */
2137         case '\024':    /* $^T */
2138         case '\027':    /* $^W */
2139         magicalize:
2140             sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
2141             break;
2142
2143         case '\014':    /* $^L */
2144             sv_setpvs(GvSVn(gv),"\f");
2145             break;
2146         case ';':               /* $; */
2147             sv_setpvs(GvSVn(gv),"\034");
2148             break;
2149         case ']':               /* $] */
2150         {
2151             SV * const sv = GvSV(gv);
2152             if (!sv_derived_from(PL_patchlevel, "version"))
2153                 upg_version(PL_patchlevel, TRUE);
2154             GvSV(gv) = vnumify(PL_patchlevel);
2155             SvREADONLY_on(GvSV(gv));
2156             SvREFCNT_dec(sv);
2157         }
2158         break;
2159         case '\026':    /* $^V */
2160         {
2161             SV * const sv = GvSV(gv);
2162             GvSV(gv) = new_version(PL_patchlevel);
2163             SvREADONLY_on(GvSV(gv));
2164             SvREFCNT_dec(sv);
2165         }
2166         break;
2167         case 'a':
2168         case 'b':
2169             if (sv_type == SVt_PV)
2170                 GvMULTI_on(gv);
2171         }
2172     }
2173
2174     return addmg;
2175 }
2176
2177 /* If we do ever start using this later on in the file, we need to make
2178    sure we don’t accidentally use the wrong definition.  */
2179 #undef SvREADONLY_on
2180
2181 /* This function is called when the stash already holds the GV of the magic
2182  * variable we're looking for, but we need to check that it has the correct
2183  * kind of magic.  For example, if someone first uses $! and then %!, the
2184  * latter would end up here, and we add the Errno tie to the HASH slot of
2185  * the *! glob.
2186  */
2187 PERL_STATIC_INLINE void
2188 S_maybe_multimagic_gv(pTHX_ GV *gv, const char *name, const svtype sv_type)
2189 {
2190     PERL_ARGS_ASSERT_MAYBE_MULTIMAGIC_GV;
2191
2192     if (sv_type == SVt_PVHV || sv_type == SVt_PVGV) {
2193         if (*name == '!')
2194             require_tie_mod(gv, "!", newSVpvs("Errno"), "TIEHASH", 1);
2195         else if (*name == '-' || *name == '+')
2196             require_tie_mod(gv, name, newSVpvs("Tie::Hash::NamedCapture"), "TIEHASH", 0);
2197     } else if (sv_type == SVt_PV) {
2198         if (*name == '*' || *name == '#') {
2199             /* diag_listed_as: $* is no longer supported */
2200             Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED,
2201                                              WARN_SYNTAX),
2202                              "$%c is no longer supported", *name);
2203         }
2204     }
2205     if (sv_type==SVt_PV || sv_type==SVt_PVGV) {
2206       switch (*name) {
2207       case '[':
2208           require_tie_mod(gv,name,newSVpvs("arybase"),"FETCH",0);
2209           break;
2210 #ifdef PERL_SAWAMPERSAND
2211       case '`':
2212           PL_sawampersand |= SAWAMPERSAND_LEFT;
2213           (void)GvSVn(gv);
2214           break;
2215       case '&':
2216           PL_sawampersand |= SAWAMPERSAND_MIDDLE;
2217           (void)GvSVn(gv);
2218           break;
2219       case '\'':
2220           PL_sawampersand |= SAWAMPERSAND_RIGHT;
2221           (void)GvSVn(gv);
2222           break;
2223 #endif
2224       }
2225     }
2226 }
2227
2228 GV *
2229 Perl_gv_fetchpvn_flags(pTHX_ const char *nambeg, STRLEN full_len, I32 flags,
2230                        const svtype sv_type)
2231 {
2232     const char *name = nambeg;
2233     GV *gv = NULL;
2234     GV**gvp;
2235     STRLEN len;
2236     HV *stash = NULL;
2237     const I32 no_init = flags & (GV_NOADD_NOINIT | GV_NOINIT);
2238     const I32 no_expand = flags & GV_NOEXPAND;
2239     const I32 add = flags & ~GV_NOADD_MASK;
2240     const U32 is_utf8 = flags & SVf_UTF8;
2241     bool addmg = cBOOL(flags & GV_ADDMG);
2242     const char *const name_end = nambeg + full_len;
2243     U32 faking_it;
2244
2245     PERL_ARGS_ASSERT_GV_FETCHPVN_FLAGS;
2246
2247      /* If we have GV_NOTQUAL, the caller promised that
2248       * there is no stash, so we can skip the check.
2249       * Similarly if full_len is 0, since then we're
2250       * dealing with something like *{""} or ""->foo()
2251       */
2252     if ((flags & GV_NOTQUAL) || !full_len) {
2253         len = full_len;
2254     }
2255     else if (parse_gv_stash_name(&stash, &gv, &name, &len, nambeg, full_len, is_utf8, add)) {
2256         if (name == name_end) return gv;
2257     }
2258     else {
2259         return NULL;
2260     }
2261
2262     if (!stash && !find_default_stash(&stash, name, len, is_utf8, add, sv_type)) {
2263         return NULL;
2264     }
2265     
2266     /* By this point we should have a stash and a name */
2267     gvp = (GV**)hv_fetch(stash,name,is_utf8 ? -(I32)len : (I32)len,add);
2268     if (!gvp || *gvp == (const GV *)&PL_sv_undef) {
2269         if (addmg) gv = (GV *)newSV(0);
2270         else return NULL;
2271     }
2272     else gv = *gvp, addmg = 0;
2273     /* From this point on, addmg means gv has not been inserted in the
2274        symtab yet. */
2275
2276     if (SvTYPE(gv) == SVt_PVGV) {
2277         /* The GV already exists, so return it, but check if we need to do
2278          * anything else with it before that.
2279          */
2280         if (add) {
2281             /* This is the heuristic that handles if a variable triggers the
2282              * 'used only once' warning.  If there's already a GV in the stash
2283              * with this name, then we assume that the variable has been used
2284              * before and turn its MULTI flag on.
2285              * It's a heuristic because it can easily be "tricked", like with
2286              * BEGIN { $a = 1; $::{foo} = *a }; () = $foo
2287              * not warning about $main::foo being used just once
2288              */
2289             GvMULTI_on(gv);
2290             gv_init_svtype(gv, sv_type);
2291             /* You reach this path once the typeglob has already been created,
2292                either by the same or a different sigil.  If this path didn't
2293                exist, then (say) referencing $! first, and %! second would
2294                mean that %! was not handled correctly.  */
2295             if (len == 1 && stash == PL_defstash) {
2296                 maybe_multimagic_gv(gv, name, sv_type);
2297             }
2298             else if (len == 3 && sv_type == SVt_PVAV
2299                   && strnEQ(name, "ISA", 3)
2300                   && (!GvAV(gv) || !SvSMAGICAL(GvAV(gv))))
2301                 gv_magicalize_isa(gv);
2302         }
2303         return gv;
2304     } else if (no_init) {
2305         assert(!addmg);
2306         return gv;
2307     }
2308     /* If GV_NOEXPAND is true and what we got off the stash is a ref,
2309      * don't expand it to a glob. This is an optimization so that things
2310      * copying constants over, like Exporter, don't have to be rewritten
2311      * to take into account that you can store more than just globs in
2312      * stashes.
2313      */
2314     else if (no_expand && SvROK(gv)) {
2315         assert(!addmg);
2316         return gv;
2317     }
2318
2319     /* Adding a new symbol.
2320        Unless of course there was already something non-GV here, in which case
2321        we want to behave as if there was always a GV here, containing some sort
2322        of subroutine.
2323        Otherwise we run the risk of creating things like GvIO, which can cause
2324        subtle bugs. eg the one that tripped up SQL::Translator  */
2325
2326     faking_it = SvOK(gv);
2327
2328     if (add & GV_ADDWARN)
2329         Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
2330                 "Had to create %"UTF8f" unexpectedly",
2331                  UTF8fARG(is_utf8, name_end-nambeg, nambeg));
2332     gv_init_pvn(gv, stash, name, len, (add & GV_ADDMULTI)|is_utf8);
2333
2334     if ( isIDFIRST_lazy_if(name, is_utf8) && !ckWARN(WARN_ONCE) )
2335         GvMULTI_on(gv) ;
2336
2337     /* First, store the gv in the symtab if we're adding magic,
2338      * but only for non-empty GVs
2339      */
2340 #define GvEMPTY(gv)      !(GvAV(gv) || GvHV(gv) || GvIO(gv) \
2341                         || GvCV(gv) || (GvSV(gv) && SvOK(GvSV(gv))))
2342     
2343     if ( addmg && !GvEMPTY(gv) ) {
2344         (void)hv_store(stash,name,len,(SV *)gv,0);
2345     }
2346
2347     /* set up magic where warranted */
2348     if ( gv_magicalize(gv, stash, name, len, addmg, sv_type) ) {
2349         /* See 23496c6 */
2350         if (GvEMPTY(gv)) {
2351             if ( GvSV(gv) && SvMAGICAL(GvSV(gv)) ) {
2352                 /* The GV was and still is "empty", except that now
2353                  * it has the magic flags turned on, so we want it
2354                  * stored in the symtab.
2355                  */
2356                 (void)hv_store(stash,name,len,(SV *)gv,0);
2357             }
2358             else {
2359                 /* Most likely the temporary GV created above */
2360                 SvREFCNT_dec_NN(gv);
2361                 gv = NULL;
2362             }
2363         }
2364     }
2365     
2366     if (gv) gv_init_svtype(gv, faking_it ? SVt_PVCV : sv_type);
2367     return gv;
2368 }
2369
2370 void
2371 Perl_gv_fullname4(pTHX_ SV *sv, const GV *gv, const char *prefix, bool keepmain)
2372 {
2373     const char *name;
2374     const HV * const hv = GvSTASH(gv);
2375
2376     PERL_ARGS_ASSERT_GV_FULLNAME4;
2377
2378     sv_setpv(sv, prefix ? prefix : "");
2379
2380     if (hv && (name = HvNAME(hv))) {
2381       const STRLEN len = HvNAMELEN(hv);
2382       if (keepmain || strnNE(name, "main", len)) {
2383         sv_catpvn_flags(sv,name,len,HvNAMEUTF8(hv)?SV_CATUTF8:SV_CATBYTES);
2384         sv_catpvs(sv,"::");
2385       }
2386     }
2387     else sv_catpvs(sv,"__ANON__::");
2388     sv_catsv(sv,sv_2mortal(newSVhek(GvNAME_HEK(gv))));
2389 }
2390
2391 void
2392 Perl_gv_efullname4(pTHX_ SV *sv, const GV *gv, const char *prefix, bool keepmain)
2393 {
2394     const GV * const egv = GvEGVx(gv);
2395
2396     PERL_ARGS_ASSERT_GV_EFULLNAME4;
2397
2398     gv_fullname4(sv, egv ? egv : gv, prefix, keepmain);
2399 }
2400
2401
2402 /* recursively scan a stash and any nested stashes looking for entries
2403  * that need the "only used once" warning raised
2404  */
2405
2406 void
2407 Perl_gv_check(pTHX_ HV *stash)
2408 {
2409     I32 i;
2410
2411     PERL_ARGS_ASSERT_GV_CHECK;
2412
2413     if (!HvARRAY(stash))
2414         return;
2415
2416     assert(SvOOK(stash));
2417
2418     for (i = 0; i <= (I32) HvMAX(stash); i++) {
2419         const HE *entry;
2420         /* mark stash is being scanned, to avoid recursing */
2421         HvAUX(stash)->xhv_aux_flags |= HvAUXf_SCAN_STASH;
2422         for (entry = HvARRAY(stash)[i]; entry; entry = HeNEXT(entry)) {
2423             GV *gv;
2424             HV *hv;
2425             if (HeKEY(entry)[HeKLEN(entry)-1] == ':' &&
2426                 (gv = MUTABLE_GV(HeVAL(entry))) && isGV(gv) && (hv = GvHV(gv)))
2427             {
2428                 if (hv != PL_defstash && hv != stash
2429                     && !(SvOOK(hv)
2430                         && (HvAUX(hv)->xhv_aux_flags & HvAUXf_SCAN_STASH))
2431                 )
2432                      gv_check(hv);              /* nested package */
2433             }
2434             else if ( *HeKEY(entry) != '_'
2435                         && isIDFIRST_lazy_if(HeKEY(entry), HeUTF8(entry)) ) {
2436                 const char *file;
2437                 gv = MUTABLE_GV(HeVAL(entry));
2438                 if (SvTYPE(gv) != SVt_PVGV || GvMULTI(gv))
2439                     continue;
2440                 file = GvFILE(gv);
2441                 CopLINE_set(PL_curcop, GvLINE(gv));
2442 #ifdef USE_ITHREADS
2443                 CopFILE(PL_curcop) = (char *)file;      /* set for warning */
2444 #else
2445                 CopFILEGV(PL_curcop)
2446                     = gv_fetchfile_flags(file, HEK_LEN(GvFILE_HEK(gv)), 0);
2447 #endif
2448                 Perl_warner(aTHX_ packWARN(WARN_ONCE),
2449                         "Name \"%"HEKf"::%"HEKf
2450                         "\" used only once: possible typo",
2451                             HEKfARG(HvNAME_HEK(stash)),
2452                             HEKfARG(GvNAME_HEK(gv)));
2453             }
2454         }
2455         HvAUX(stash)->xhv_aux_flags &= ~HvAUXf_SCAN_STASH;
2456     }
2457 }
2458
2459 GV *
2460 Perl_newGVgen_flags(pTHX_ const char *pack, U32 flags)
2461 {
2462     PERL_ARGS_ASSERT_NEWGVGEN_FLAGS;
2463     assert(!(flags & ~SVf_UTF8));
2464
2465     return gv_fetchpv(Perl_form(aTHX_ "%"UTF8f"::_GEN_%ld",
2466                                 UTF8fARG(flags, strlen(pack), pack),
2467                                 (long)PL_gensym++),
2468                       GV_ADD, SVt_PVGV);
2469 }
2470
2471 /* hopefully this is only called on local symbol table entries */
2472
2473 GP*
2474 Perl_gp_ref(pTHX_ GP *gp)
2475 {
2476     if (!gp)
2477         return NULL;
2478     gp->gp_refcnt++;
2479     if (gp->gp_cv) {
2480         if (gp->gp_cvgen) {
2481             /* If the GP they asked for a reference to contains
2482                a method cache entry, clear it first, so that we
2483                don't infect them with our cached entry */
2484             SvREFCNT_dec_NN(gp->gp_cv);
2485             gp->gp_cv = NULL;
2486             gp->gp_cvgen = 0;
2487         }
2488     }
2489     return gp;
2490 }
2491
2492 void
2493 Perl_gp_free(pTHX_ GV *gv)
2494 {
2495     GP* gp;
2496     int attempts = 100;
2497
2498     if (!gv || !isGV_with_GP(gv) || !(gp = GvGP(gv)))
2499         return;
2500     if (gp->gp_refcnt == 0) {
2501         Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
2502                          "Attempt to free unreferenced glob pointers"
2503                          pTHX__FORMAT pTHX__VALUE);
2504         return;
2505     }
2506     if (gp->gp_refcnt > 1) {
2507        borrowed:
2508         if (gp->gp_egv == gv)
2509             gp->gp_egv = 0;
2510         gp->gp_refcnt--;
2511         GvGP_set(gv, NULL);
2512         return;
2513     }
2514
2515     while (1) {
2516       /* Copy and null out all the glob slots, so destructors do not see
2517          freed SVs. */
2518       HEK * const file_hek = gp->gp_file_hek;
2519       SV  * const sv       = gp->gp_sv;
2520       AV  * const av       = gp->gp_av;
2521       HV  * const hv       = gp->gp_hv;
2522       IO  * const io       = gp->gp_io;
2523       CV  * const cv       = gp->gp_cv;
2524       CV  * const form     = gp->gp_form;
2525
2526       gp->gp_file_hek = NULL;
2527       gp->gp_sv       = NULL;
2528       gp->gp_av       = NULL;
2529       gp->gp_hv       = NULL;
2530       gp->gp_io       = NULL;
2531       gp->gp_cv       = NULL;
2532       gp->gp_form     = NULL;
2533
2534       if (file_hek)
2535         unshare_hek(file_hek);
2536
2537       SvREFCNT_dec(sv);
2538       SvREFCNT_dec(av);
2539       /* FIXME - another reference loop GV -> symtab -> GV ?
2540          Somehow gp->gp_hv can end up pointing at freed garbage.  */
2541       if (hv && SvTYPE(hv) == SVt_PVHV) {
2542         const HEK *hvname_hek = HvNAME_HEK(hv);
2543         DEBUG_o(Perl_deb(aTHX_ "gp_free clearing PL_stashcache for '%"HEKf"'\n", HEKfARG(hvname_hek)));
2544         if (PL_stashcache && hvname_hek)
2545            (void)hv_deletehek(PL_stashcache, hvname_hek, G_DISCARD);
2546         SvREFCNT_dec(hv);
2547       }
2548       if (io && SvREFCNT(io) == 1 && IoIFP(io)
2549              && (IoTYPE(io) == IoTYPE_WRONLY ||
2550                  IoTYPE(io) == IoTYPE_RDWR   ||
2551                  IoTYPE(io) == IoTYPE_APPEND)
2552              && ckWARN_d(WARN_IO)
2553              && IoIFP(io) != PerlIO_stdin()
2554              && IoIFP(io) != PerlIO_stdout()
2555              && IoIFP(io) != PerlIO_stderr()
2556              && !(IoFLAGS(io) & IOf_FAKE_DIRP))
2557         io_close(io, gv, FALSE, TRUE);
2558       SvREFCNT_dec(io);
2559       SvREFCNT_dec(cv);
2560       SvREFCNT_dec(form);
2561
2562       /* Possibly reallocated by a destructor */
2563       gp = GvGP(gv);
2564
2565       if (!gp->gp_file_hek
2566        && !gp->gp_sv
2567        && !gp->gp_av
2568        && !gp->gp_hv
2569        && !gp->gp_io
2570        && !gp->gp_cv
2571        && !gp->gp_form) break;
2572
2573       if (--attempts == 0) {
2574         Perl_die(aTHX_
2575           "panic: gp_free failed to free glob pointer - "
2576           "something is repeatedly re-creating entries"
2577         );
2578       }
2579     }
2580
2581     /* Possibly incremented by a destructor doing glob assignment */
2582     if (gp->gp_refcnt > 1) goto borrowed;
2583     Safefree(gp);
2584     GvGP_set(gv, NULL);
2585 }
2586
2587 int
2588 Perl_magic_freeovrld(pTHX_ SV *sv, MAGIC *mg)
2589 {
2590     AMT * const amtp = (AMT*)mg->mg_ptr;
2591     PERL_UNUSED_ARG(sv);
2592
2593     PERL_ARGS_ASSERT_MAGIC_FREEOVRLD;
2594
2595     if (amtp && AMT_AMAGIC(amtp)) {
2596         int i;
2597         for (i = 1; i < NofAMmeth; i++) {
2598             CV * const cv = amtp->table[i];
2599             if (cv) {
2600                 SvREFCNT_dec_NN(MUTABLE_SV(cv));
2601                 amtp->table[i] = NULL;
2602             }
2603         }
2604     }
2605  return 0;
2606 }
2607
2608 /* Updates and caches the CV's */
2609 /* Returns:
2610  * 1 on success and there is some overload
2611  * 0 if there is no overload
2612  * -1 if some error occurred and it couldn't croak
2613  */
2614
2615 int
2616 Perl_Gv_AMupdate(pTHX_ HV *stash, bool destructing)
2617 {
2618   MAGIC* const mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
2619   AMT amt;
2620   const struct mro_meta* stash_meta = HvMROMETA(stash);
2621   U32 newgen;
2622
2623   PERL_ARGS_ASSERT_GV_AMUPDATE;
2624
2625   newgen = PL_sub_generation + stash_meta->pkg_gen + stash_meta->cache_gen;
2626   if (mg) {
2627       const AMT * const amtp = (AMT*)mg->mg_ptr;
2628       if (amtp->was_ok_sub == newgen) {
2629           return AMT_AMAGIC(amtp) ? 1 : 0;
2630       }
2631       sv_unmagic(MUTABLE_SV(stash), PERL_MAGIC_overload_table);
2632   }
2633
2634   DEBUG_o( Perl_deb(aTHX_ "Recalcing overload magic in package %s\n",HvNAME_get(stash)) );
2635
2636   Zero(&amt,1,AMT);
2637   amt.was_ok_sub = newgen;
2638   amt.fallback = AMGfallNO;
2639   amt.flags = 0;
2640
2641   {
2642     int filled = 0;
2643     int i;
2644     bool deref_seen = 0;
2645
2646
2647     /* Work with "fallback" key, which we assume to be first in PL_AMG_names */
2648
2649     /* Try to find via inheritance. */
2650     GV *gv = gv_fetchmeth_pvn(stash, PL_AMG_names[0], 2, -1, 0);
2651     SV * const sv = gv ? GvSV(gv) : NULL;
2652     CV* cv;
2653
2654     if (!gv)
2655     {
2656       if (!gv_fetchmeth_pvn(stash, "((", 2, -1, 0))
2657         goto no_table;
2658     }
2659 #ifdef PERL_DONT_CREATE_GVSV
2660     else if (!sv) {
2661         NOOP;   /* Equivalent to !SvTRUE and !SvOK  */
2662     }
2663 #endif
2664     else if (SvTRUE(sv))
2665         /* don't need to set overloading here because fallback => 1
2666          * is the default setting for classes without overloading */
2667         amt.fallback=AMGfallYES;
2668     else if (SvOK(sv)) {
2669         amt.fallback=AMGfallNEVER;
2670         filled = 1;
2671     }
2672     else {
2673         filled = 1;
2674     }
2675
2676     assert(SvOOK(stash));
2677     /* initially assume the worst */
2678     HvAUX(stash)->xhv_aux_flags &= ~HvAUXf_NO_DEREF;
2679
2680     for (i = 1; i < NofAMmeth; i++) {
2681         const char * const cooky = PL_AMG_names[i];
2682         /* Human-readable form, for debugging: */
2683         const char * const cp = AMG_id2name(i);
2684         const STRLEN l = PL_AMG_namelens[i];
2685
2686         DEBUG_o( Perl_deb(aTHX_ "Checking overloading of \"%s\" in package \"%.256s\"\n",
2687                      cp, HvNAME_get(stash)) );
2688         /* don't fill the cache while looking up!
2689            Creation of inheritance stubs in intermediate packages may
2690            conflict with the logic of runtime method substitution.
2691            Indeed, for inheritance A -> B -> C, if C overloads "+0",
2692            then we could have created stubs for "(+0" in A and C too.
2693            But if B overloads "bool", we may want to use it for
2694            numifying instead of C's "+0". */
2695         gv = Perl_gv_fetchmeth_pvn(aTHX_ stash, cooky, l, -1, 0);
2696         cv = 0;
2697         if (gv && (cv = GvCV(gv)) && CvHASGV(cv)) {
2698             const HEK * const gvhek =
2699                 CvNAMED(cv) ? CvNAME_HEK(cv) : GvNAME_HEK(CvGV(cv));
2700             const HEK * const stashek =
2701                 HvNAME_HEK(CvNAMED(cv) ? CvSTASH(cv) : GvSTASH(CvGV(cv)));
2702             if (HEK_LEN(gvhek) == 3 && strEQ(HEK_KEY(gvhek), "nil")
2703              && stashek && HEK_LEN(stashek) == 8
2704              && strEQ(HEK_KEY(stashek), "overload")) {
2705                 /* This is a hack to support autoloading..., while
2706                    knowing *which* methods were declared as overloaded. */
2707                 /* GvSV contains the name of the method. */
2708                 GV *ngv = NULL;
2709                 SV *gvsv = GvSV(gv);
2710
2711                 DEBUG_o( Perl_deb(aTHX_ "Resolving method \"%"SVf256\
2712                         "\" for overloaded \"%s\" in package \"%.256s\"\n",
2713                              (void*)GvSV(gv), cp, HvNAME(stash)) );
2714                 if (!gvsv || !SvPOK(gvsv)
2715                     || !(ngv = gv_fetchmethod_sv_flags(stash, gvsv, 0)))
2716                 {
2717                     /* Can be an import stub (created by "can"). */
2718                     if (destructing) {
2719                         return -1;
2720                     }
2721                     else {
2722                         const SV * const name = (gvsv && SvPOK(gvsv))
2723                                                     ? gvsv
2724                                                     : newSVpvs_flags("???", SVs_TEMP);
2725                         /* diag_listed_as: Can't resolve method "%s" overloading "%s" in package "%s" */
2726                         Perl_croak(aTHX_ "%s method \"%"SVf256
2727                                     "\" overloading \"%s\" "\
2728                                     "in package \"%"HEKf256"\"",
2729                                    (GvCVGEN(gv) ? "Stub found while resolving"
2730                                     : "Can't resolve"),
2731                                    SVfARG(name), cp,
2732                                    HEKfARG(
2733                                         HvNAME_HEK(stash)
2734                                    ));
2735                     }
2736                 }
2737                 cv = GvCV(gv = ngv);
2738             }
2739             DEBUG_o( Perl_deb(aTHX_ "Overloading \"%s\" in package \"%.256s\" via \"%.256s::%.256s\"\n",
2740                          cp, HvNAME_get(stash), HvNAME_get(GvSTASH(CvGV(cv))),
2741                          GvNAME(CvGV(cv))) );
2742             filled = 1;
2743         } else if (gv) {                /* Autoloaded... */
2744             cv = MUTABLE_CV(gv);
2745             filled = 1;
2746         }
2747         amt.table[i]=MUTABLE_CV(SvREFCNT_inc_simple(cv));
2748
2749         if (gv) {
2750             switch (i) {
2751             case to_sv_amg:
2752             case to_av_amg:
2753             case to_hv_amg:
2754             case to_gv_amg:
2755             case to_cv_amg:
2756             case nomethod_amg:
2757                 deref_seen = 1;
2758                 break;
2759             }
2760         }
2761     }
2762     if (!deref_seen)
2763         /* none of @{} etc overloaded; we can do $obj->[N] quicker.
2764          * NB - aux var invalid here, HvARRAY() could have been
2765          * reallocated since it was assigned to */
2766         HvAUX(stash)->xhv_aux_flags |= HvAUXf_NO_DEREF;
2767
2768     if (filled) {
2769       AMT_AMAGIC_on(&amt);
2770       sv_magic(MUTABLE_SV(stash), 0, PERL_MAGIC_overload_table,
2771                                                 (char*)&amt, sizeof(AMT));
2772       return TRUE;
2773     }
2774   }
2775   /* Here we have no table: */
2776  no_table:
2777   AMT_AMAGIC_off(&amt);
2778   sv_magic(MUTABLE_SV(stash), 0, PERL_MAGIC_overload_table,
2779                                                 (char*)&amt, sizeof(AMTS));
2780   return 0;
2781 }
2782
2783
2784 CV*
2785 Perl_gv_handler(pTHX_ HV *stash, I32 id)
2786 {
2787     MAGIC *mg;
2788     AMT *amtp;
2789     U32 newgen;
2790     struct mro_meta* stash_meta;
2791
2792     if (!stash || !HvNAME_get(stash))
2793         return NULL;
2794
2795     stash_meta = HvMROMETA(stash);
2796     newgen = PL_sub_generation + stash_meta->pkg_gen + stash_meta->cache_gen;
2797
2798     mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
2799     if (!mg) {
2800       do_update:
2801         if (Gv_AMupdate(stash, 0) == -1)
2802             return NULL;
2803         mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
2804     }
2805     assert(mg);
2806     amtp = (AMT*)mg->mg_ptr;
2807     if ( amtp->was_ok_sub != newgen )
2808         goto do_update;
2809     if (AMT_AMAGIC(amtp)) {
2810         CV * const ret = amtp->table[id];
2811         if (ret && isGV(ret)) {         /* Autoloading stab */
2812             /* Passing it through may have resulted in a warning
2813                "Inherited AUTOLOAD for a non-method deprecated", since
2814                our caller is going through a function call, not a method call.
2815                So return the CV for AUTOLOAD, setting $AUTOLOAD. */
2816             GV * const gv = gv_fetchmethod(stash, PL_AMG_names[id]);
2817
2818             if (gv && GvCV(gv))
2819                 return GvCV(gv);
2820         }
2821         return ret;
2822     }
2823
2824     return NULL;
2825 }
2826
2827
2828 /* Implement tryAMAGICun_MG macro.
2829    Do get magic, then see if the stack arg is overloaded and if so call it.
2830    Flags:
2831         AMGf_set     return the arg using SETs rather than assigning to
2832                      the targ
2833         AMGf_numeric apply sv_2num to the stack arg.
2834 */
2835
2836 bool
2837 Perl_try_amagic_un(pTHX_ int method, int flags) {
2838     dSP;
2839     SV* tmpsv;
2840     SV* const arg = TOPs;
2841
2842     SvGETMAGIC(arg);
2843
2844     if (SvAMAGIC(arg) && (tmpsv = amagic_call(arg, &PL_sv_undef, method,
2845                                               AMGf_noright | AMGf_unary))) {
2846         if (flags & AMGf_set) {
2847             SETs(tmpsv);
2848         }
2849         else {
2850             dTARGET;
2851             if (SvPADMY(TARG)) {
2852                 sv_setsv(TARG, tmpsv);
2853                 SETTARG;
2854             }
2855             else
2856                 SETs(tmpsv);
2857         }
2858         PUTBACK;
2859         return TRUE;
2860     }
2861
2862     if ((flags & AMGf_numeric) && SvROK(arg))
2863         *sp = sv_2num(arg);
2864     return FALSE;
2865 }
2866
2867
2868 /* Implement tryAMAGICbin_MG macro.
2869    Do get magic, then see if the two stack args are overloaded and if so
2870    call it.
2871    Flags:
2872         AMGf_set     return the arg using SETs rather than assigning to
2873                      the targ
2874         AMGf_assign  op may be called as mutator (eg +=)
2875         AMGf_numeric apply sv_2num to the stack arg.
2876 */
2877
2878 bool
2879 Perl_try_amagic_bin(pTHX_ int method, int flags) {
2880     dSP;
2881     SV* const left = TOPm1s;
2882     SV* const right = TOPs;
2883
2884     SvGETMAGIC(left);
2885     if (left != right)
2886         SvGETMAGIC(right);
2887
2888     if (SvAMAGIC(left) || SvAMAGIC(right)) {
2889         SV * const tmpsv = amagic_call(left, right, method,
2890                     ((flags & AMGf_assign) && opASSIGN ? AMGf_assign: 0));
2891         if (tmpsv) {
2892             if (flags & AMGf_set) {
2893                 (void)POPs;
2894                 SETs(tmpsv);
2895             }
2896             else {
2897                 dATARGET;
2898                 (void)POPs;
2899                 if (opASSIGN || SvPADMY(TARG)) {
2900                     sv_setsv(TARG, tmpsv);
2901                     SETTARG;
2902                 }
2903                 else
2904                     SETs(tmpsv);
2905             }
2906             PUTBACK;
2907             return TRUE;
2908         }
2909     }
2910     if(left==right && SvGMAGICAL(left)) {
2911         SV * const left = sv_newmortal();
2912         *(sp-1) = left;
2913         /* Print the uninitialized warning now, so it includes the vari-
2914            able name. */
2915         if (!SvOK(right)) {
2916             if (ckWARN(WARN_UNINITIALIZED)) report_uninit(right);
2917             sv_setsv_flags(left, &PL_sv_no, 0);
2918         }
2919         else sv_setsv_flags(left, right, 0);
2920         SvGETMAGIC(right);
2921     }
2922     if (flags & AMGf_numeric) {
2923         if (SvROK(TOPm1s))
2924             *(sp-1) = sv_2num(TOPm1s);
2925         if (SvROK(right))
2926             *sp     = sv_2num(right);
2927     }
2928     return FALSE;
2929 }
2930
2931 SV *
2932 Perl_amagic_deref_call(pTHX_ SV *ref, int method) {
2933     SV *tmpsv = NULL;
2934     HV *stash;
2935
2936     PERL_ARGS_ASSERT_AMAGIC_DEREF_CALL;
2937
2938     if (!SvAMAGIC(ref))
2939         return ref;
2940     /* return quickly if none of the deref ops are overloaded */
2941     stash = SvSTASH(SvRV(ref));
2942     assert(SvOOK(stash));
2943     if (HvAUX(stash)->xhv_aux_flags & HvAUXf_NO_DEREF)
2944         return ref;
2945
2946     while ((tmpsv = amagic_call(ref, &PL_sv_undef, method,
2947                                 AMGf_noright | AMGf_unary))) { 
2948         if (!SvROK(tmpsv))
2949             Perl_croak(aTHX_ "Overloaded dereference did not return a reference");
2950         if (tmpsv == ref || SvRV(tmpsv) == SvRV(ref)) {
2951             /* Bail out if it returns us the same reference.  */
2952             return tmpsv;
2953         }
2954         ref = tmpsv;
2955         if (!SvAMAGIC(ref))
2956             break;
2957     }
2958     return tmpsv ? tmpsv : ref;
2959 }
2960
2961 bool
2962 Perl_amagic_is_enabled(pTHX_ int method)
2963 {
2964       SV *lex_mask = cop_hints_fetch_pvs(PL_curcop, "overloading", 0);
2965
2966       assert(PL_curcop->cop_hints & HINT_NO_AMAGIC);
2967
2968       if ( !lex_mask || !SvOK(lex_mask) )
2969           /* overloading lexically disabled */
2970           return FALSE;
2971       else if ( lex_mask && SvPOK(lex_mask) ) {
2972           /* we have an entry in the hints hash, check if method has been
2973            * masked by overloading.pm */
2974           STRLEN len;
2975           const int offset = method / 8;
2976           const int bit    = method % 8;
2977           char *pv = SvPV(lex_mask, len);
2978
2979           /* Bit set, so this overloading operator is disabled */
2980           if ( (STRLEN)offset < len && pv[offset] & ( 1 << bit ) )
2981               return FALSE;
2982       }
2983       return TRUE;
2984 }
2985
2986 SV*
2987 Perl_amagic_call(pTHX_ SV *left, SV *right, int method, int flags)
2988 {
2989   dVAR;
2990   MAGIC *mg;
2991   CV *cv=NULL;
2992   CV **cvp=NULL, **ocvp=NULL;
2993   AMT *amtp=NULL, *oamtp=NULL;
2994   int off = 0, off1, lr = 0, notfound = 0;
2995   int postpr = 0, force_cpy = 0;
2996   int assign = AMGf_assign & flags;
2997   const int assignshift = assign ? 1 : 0;
2998   int use_default_op = 0;
2999   int force_scalar = 0;
3000 #ifdef DEBUGGING
3001   int fl=0;
3002 #endif
3003   HV* stash=NULL;
3004
3005   PERL_ARGS_ASSERT_AMAGIC_CALL;
3006
3007   if ( PL_curcop->cop_hints & HINT_NO_AMAGIC ) {
3008       if (!amagic_is_enabled(method)) return NULL;
3009   }
3010
3011   if (!(AMGf_noleft & flags) && SvAMAGIC(left)
3012       && (stash = SvSTASH(SvRV(left))) && Gv_AMG(stash)
3013       && (mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table))
3014       && (ocvp = cvp = (AMT_AMAGIC((AMT*)mg->mg_ptr)
3015                         ? (oamtp = amtp = (AMT*)mg->mg_ptr)->table
3016                         : NULL))
3017       && ((cv = cvp[off=method+assignshift])
3018           || (assign && amtp->fallback > AMGfallNEVER && /* fallback to
3019                                                           * usual method */
3020                   (
3021 #ifdef DEBUGGING
3022                    fl = 1,
3023 #endif
3024                    cv = cvp[off=method])))) {
3025     lr = -1;                    /* Call method for left argument */
3026   } else {
3027     if (cvp && amtp->fallback > AMGfallNEVER && flags & AMGf_unary) {
3028       int logic;
3029
3030       /* look for substituted methods */
3031       /* In all the covered cases we should be called with assign==0. */
3032          switch (method) {
3033          case inc_amg:
3034            force_cpy = 1;
3035            if ((cv = cvp[off=add_ass_amg])
3036                || ((cv = cvp[off = add_amg]) && (force_cpy = 0, postpr = 1))) {
3037              right = &PL_sv_yes; lr = -1; assign = 1;
3038            }
3039            break;
3040          case dec_amg:
3041            force_cpy = 1;
3042            if ((cv = cvp[off = subtr_ass_amg])
3043                || ((cv = cvp[off = subtr_amg]) && (force_cpy = 0, postpr=1))) {
3044              right = &PL_sv_yes; lr = -1; assign = 1;
3045            }
3046            break;
3047          case bool__amg:
3048            (void)((cv = cvp[off=numer_amg]) || (cv = cvp[off=string_amg]));
3049            break;
3050          case numer_amg:
3051            (void)((cv = cvp[off=string_amg]) || (cv = cvp[off=bool__amg]));
3052            break;
3053          case string_amg:
3054            (void)((cv = cvp[off=numer_amg]) || (cv = cvp[off=bool__amg]));
3055            break;
3056          case not_amg:
3057            (void)((cv = cvp[off=bool__amg])
3058                   || (cv = cvp[off=numer_amg])
3059                   || (cv = cvp[off=string_amg]));
3060            if (cv)
3061                postpr = 1;
3062            break;
3063          case copy_amg:
3064            {
3065              /*
3066                   * SV* ref causes confusion with the interpreter variable of
3067                   * the same name
3068                   */
3069              SV* const tmpRef=SvRV(left);
3070              if (!SvROK(tmpRef) && SvTYPE(tmpRef) <= SVt_PVMG) {
3071                 /*
3072                  * Just to be extra cautious.  Maybe in some
3073                  * additional cases sv_setsv is safe, too.
3074                  */
3075                 SV* const newref = newSVsv(tmpRef);
3076                 SvOBJECT_on(newref);
3077                 /* No need to do SvAMAGIC_on here, as SvAMAGIC macros
3078                    delegate to the stash. */
3079                 SvSTASH_set(newref, MUTABLE_HV(SvREFCNT_inc(SvSTASH(tmpRef))));
3080                 return newref;
3081              }
3082            }
3083            break;
3084          case abs_amg:
3085            if ((cvp[off1=lt_amg] || cvp[off1=ncmp_amg])
3086                && ((cv = cvp[off=neg_amg]) || (cv = cvp[off=subtr_amg]))) {
3087              SV* const nullsv=sv_2mortal(newSViv(0));
3088              if (off1==lt_amg) {
3089                SV* const lessp = amagic_call(left,nullsv,
3090                                        lt_amg,AMGf_noright);
3091                logic = SvTRUE(lessp);
3092              } else {
3093                SV* const lessp = amagic_call(left,nullsv,
3094                                        ncmp_amg,AMGf_noright);
3095                logic = (SvNV(lessp) < 0);
3096              }
3097              if (logic) {
3098                if (off==subtr_amg) {
3099                  right = left;
3100                  left = nullsv;
3101                  lr = 1;
3102                }
3103              } else {
3104                return left;
3105              }
3106            }
3107            break;
3108          case neg_amg:
3109            if ((cv = cvp[off=subtr_amg])) {
3110              right = left;
3111              left = sv_2mortal(newSViv(0));
3112              lr = 1;
3113            }
3114            break;
3115          case int_amg:
3116          case iter_amg:                 /* XXXX Eventually should do to_gv. */
3117          case ftest_amg:                /* XXXX Eventually should do to_gv. */
3118          case regexp_amg:
3119              /* FAIL safe */
3120              return NULL;       /* Delegate operation to standard mechanisms. */
3121
3122          case to_sv_amg:
3123          case to_av_amg:
3124          case to_hv_amg:
3125          case to_gv_amg:
3126          case to_cv_amg:
3127              /* FAIL safe */
3128              return left;       /* Delegate operation to standard mechanisms. */
3129
3130          default:
3131            goto not_found;
3132          }
3133          if (!cv) goto not_found;
3134     } else if (!(AMGf_noright & flags) && SvAMAGIC(right)
3135                && (stash = SvSTASH(SvRV(right))) && Gv_AMG(stash)
3136                && (mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table))
3137                && (cvp = (AMT_AMAGIC((AMT*)mg->mg_ptr)
3138                           ? (amtp = (AMT*)mg->mg_ptr)->table
3139                           : NULL))
3140                && (cv = cvp[off=method])) { /* Method for right
3141                                              * argument found */
3142       lr=1;
3143     } else if (((cvp && amtp->fallback > AMGfallNEVER)
3144                 || (ocvp && oamtp->fallback > AMGfallNEVER))
3145                && !(flags & AMGf_unary)) {
3146                                 /* We look for substitution for
3147                                  * comparison operations and
3148                                  * concatenation */
3149       if (method==concat_amg || method==concat_ass_amg
3150           || method==repeat_amg || method==repeat_ass_amg) {
3151         return NULL;            /* Delegate operation to string conversion */
3152       }
3153       off = -1;
3154       switch (method) {
3155          case lt_amg:
3156          case le_amg:
3157          case gt_amg:
3158          case ge_amg:
3159          case eq_amg:
3160          case ne_amg:
3161              off = ncmp_amg;
3162              break;
3163          case slt_amg:
3164          case sle_amg:
3165          case sgt_amg:
3166          case sge_amg:
3167          case seq_amg:
3168          case sne_amg:
3169              off = scmp_amg;
3170              break;
3171          }
3172       if (off != -1) {
3173           if (ocvp && (oamtp->fallback > AMGfallNEVER)) {
3174               cv = ocvp[off];
3175               lr = -1;
3176           }
3177           if (!cv && (cvp && amtp->fallback > AMGfallNEVER)) {
3178               cv = cvp[off];
3179               lr = 1;
3180           }
3181       }
3182       if (cv)
3183           postpr = 1;
3184       else
3185           goto not_found;
3186     } else {
3187     not_found:                  /* No method found, either report or croak */
3188       switch (method) {
3189          case to_sv_amg:
3190          case to_av_amg:
3191          case to_hv_amg:
3192          case to_gv_amg:
3193          case to_cv_amg:
3194              /* FAIL safe */
3195              return left;       /* Delegate operation to standard mechanisms. */
3196       }
3197       if (ocvp && (cv=ocvp[nomethod_amg])) { /* Call report method */
3198         notfound = 1; lr = -1;
3199       } else if (cvp && (cv=cvp[nomethod_amg])) {
3200         notfound = 1; lr = 1;
3201       } else if ((use_default_op =
3202                   (!ocvp || oamtp->fallback >= AMGfallYES)
3203                   && (!cvp || amtp->fallback >= AMGfallYES))
3204                  && !DEBUG_o_TEST) {
3205         /* Skip generating the "no method found" message.  */
3206         return NULL;
3207       } else {
3208         SV *msg;
3209         if (off==-1) off=method;
3210         msg = sv_2mortal(Perl_newSVpvf(aTHX_
3211                       "Operation \"%s\": no method found,%sargument %s%"SVf"%s%"SVf,
3212                       AMG_id2name(method + assignshift),
3213                       (flags & AMGf_unary ? " " : "\n\tleft "),
3214                       SvAMAGIC(left)?
3215                         "in overloaded package ":
3216                         "has no overloaded magic",
3217                       SvAMAGIC(left)?
3218                         SVfARG(sv_2mortal(newSVhek(HvNAME_HEK(SvSTASH(SvRV(left)))))):
3219                         SVfARG(&PL_sv_no),
3220                       SvAMAGIC(right)?
3221                         ",\n\tright argument in overloaded package ":
3222                         (flags & AMGf_unary
3223                          ? ""
3224                          : ",\n\tright argument has no overloaded magic"),
3225                       SvAMAGIC(right)?
3226                         SVfARG(sv_2mortal(newSVhek(HvNAME_HEK(SvSTASH(SvRV(right)))))):
3227                         SVfARG(&PL_sv_no)));
3228         if (use_default_op) {
3229           DEBUG_o( Perl_deb(aTHX_ "%"SVf, SVfARG(msg)) );
3230         } else {
3231           Perl_croak(aTHX_ "%"SVf, SVfARG(msg));
3232         }
3233         return NULL;
3234       }
3235       force_cpy = force_cpy || assign;
3236     }
3237   }
3238
3239   switch (method) {
3240     /* in these cases, we're calling '+' or '-' as a fallback for a ++ or --
3241      * operation. we need this to return a value, so that it can be assigned
3242      * later on, in the postpr block (case inc_amg/dec_amg), even if the
3243      * increment or decrement was itself called in void context */
3244     case inc_amg:
3245       if (off == add_amg)
3246         force_scalar = 1;
3247       break;
3248     case dec_amg:
3249       if (off == subtr_amg)
3250         force_scalar = 1;
3251       break;
3252     /* in these cases, we're calling an assignment variant of an operator
3253      * (+= rather than +, for instance). regardless of whether it's a
3254      * fallback or not, it always has to return a value, which will be
3255      * assigned to the proper variable later */
3256     case add_amg:
3257     case subtr_amg:
3258     case mult_amg:
3259     case div_amg:
3260     case modulo_amg:
3261     case pow_amg:
3262     case lshift_amg:
3263     case rshift_amg:
3264     case repeat_amg:
3265     case concat_amg:
3266     case band_amg:
3267     case bor_amg:
3268     case bxor_amg:
3269       if (assign)
3270         force_scalar = 1;
3271       break;
3272     /* the copy constructor always needs to return a value */
3273     case copy_amg:
3274       force_scalar = 1;
3275       break;
3276     /* because of the way these are implemented (they don't perform the
3277      * dereferencing themselves, they return a reference that perl then
3278      * dereferences later), they always have to be in scalar context */
3279     case to_sv_amg:
3280     case to_av_amg:
3281     case to_hv_amg:
3282     case to_gv_amg:
3283     case to_cv_amg:
3284       force_scalar = 1;
3285       break;
3286     /* these don't have an op of their own; they're triggered by their parent
3287      * op, so the context there isn't meaningful ('$a and foo()' in void
3288      * context still needs to pass scalar context on to $a's bool overload) */
3289     case bool__amg:
3290     case numer_amg:
3291     case string_amg:
3292       force_scalar = 1;
3293       break;
3294   }
3295
3296 #ifdef DEBUGGING
3297   if (!notfound) {
3298     DEBUG_o(Perl_deb(aTHX_
3299                      "Overloaded operator \"%s\"%s%s%s:\n\tmethod%s found%s in package %"SVf"%s\n",
3300                      AMG_id2name(off),
3301                      method+assignshift==off? "" :
3302                      " (initially \"",
3303                      method+assignshift==off? "" :
3304                      AMG_id2name(method+assignshift),
3305                      method+assignshift==off? "" : "\")",
3306                      flags & AMGf_unary? "" :
3307                      lr==1 ? " for right argument": " for left argument",
3308                      flags & AMGf_unary? " for argument" : "",
3309                      stash ? SVfARG(sv_2mortal(newSVhek(HvNAME_HEK(stash)))) : SVfARG(newSVpvs_flags("null", SVs_TEMP)),
3310                      fl? ",\n\tassignment variant used": "") );
3311   }
3312 #endif
3313     /* Since we use shallow copy during assignment, we need
3314      * to dublicate the contents, probably calling user-supplied
3315      * version of copy operator
3316      */
3317     /* We need to copy in following cases:
3318      * a) Assignment form was called.
3319      *          assignshift==1,  assign==T, method + 1 == off
3320      * b) Increment or decrement, called directly.
3321      *          assignshift==0,  assign==0, method + 0 == off
3322      * c) Increment or decrement, translated to assignment add/subtr.
3323      *          assignshift==0,  assign==T,
3324      *          force_cpy == T
3325      * d) Increment or decrement, translated to nomethod.
3326      *          assignshift==0,  assign==0,
3327      *          force_cpy == T
3328      * e) Assignment form translated to nomethod.
3329      *          assignshift==1,  assign==T, method + 1 != off
3330      *          force_cpy == T
3331      */
3332     /*  off is method, method+assignshift, or a result of opcode substitution.
3333      *  In the latter case assignshift==0, so only notfound case is important.
3334      */
3335   if ( (lr == -1) && ( ( (method + assignshift == off)
3336         && (assign || (method == inc_amg) || (method == dec_amg)))
3337       || force_cpy) )
3338   {
3339       /* newSVsv does not behave as advertised, so we copy missing
3340        * information by hand */
3341       SV *tmpRef = SvRV(left);
3342       SV *rv_copy;
3343       if (SvREFCNT(tmpRef) > 1 && (rv_copy = AMG_CALLunary(left,copy_amg))) {
3344           SvRV_set(left, rv_copy);
3345           SvSETMAGIC(left);
3346           SvREFCNT_dec_NN(tmpRef);  
3347       }
3348   }
3349
3350   {
3351     dSP;
3352     BINOP myop;
3353     SV* res;
3354     const bool oldcatch = CATCH_GET;
3355     I32 oldmark, nret;
3356     int gimme = force_scalar ? G_SCALAR : GIMME_V;
3357
3358     CATCH_SET(TRUE);
3359     Zero(&myop, 1, BINOP);
3360     myop.op_last = (OP *) &myop;
3361     myop.op_next = NULL;
3362     myop.op_flags = OPf_STACKED;
3363
3364     switch (gimme) {
3365         case G_VOID:
3366             myop.op_flags |= OPf_WANT_VOID;
3367             break;
3368         case G_ARRAY:
3369             if (flags & AMGf_want_list) {
3370                 myop.op_flags |= OPf_WANT_LIST;
3371                 break;
3372             }
3373             /* FALLTHROUGH */
3374         default:
3375             myop.op_flags |= OPf_WANT_SCALAR;
3376             break;
3377     }
3378
3379     PUSHSTACKi(PERLSI_OVERLOAD);
3380     ENTER;
3381     SAVEOP();
3382     PL_op = (OP *) &myop;
3383     if (PERLDB_SUB && PL_curstash != PL_debstash)
3384         PL_op->op_private |= OPpENTERSUB_DB;
3385     Perl_pp_pushmark(aTHX);
3386
3387     EXTEND(SP, notfound + 5);
3388     PUSHs(lr>0? right: left);
3389     PUSHs(lr>0? left: right);
3390     PUSHs( lr > 0 ? &PL_sv_yes : ( assign ? &PL_sv_undef : &PL_sv_no ));
3391     if (notfound) {
3392       PUSHs(newSVpvn_flags(AMG_id2name(method + assignshift),
3393                            AMG_id2namelen(method + assignshift), SVs_TEMP));
3394     }
3395     PUSHs(MUTABLE_SV(cv));
3396     PUTBACK;
3397     oldmark = TOPMARK;
3398
3399     if ((PL_op = PL_ppaddr[OP_ENTERSUB](aTHX)))
3400       CALLRUNOPS(aTHX);
3401     LEAVE;
3402     SPAGAIN;
3403     nret = SP - (PL_stack_base + oldmark);
3404
3405     switch (gimme) {
3406         case G_VOID:
3407             /* returning NULL has another meaning, and we check the context
3408              * at the call site too, so this can be differentiated from the
3409              * scalar case */
3410             res = &PL_sv_undef;
3411             SP = PL_stack_base + oldmark;
3412             break;
3413         case G_ARRAY: {
3414             if (flags & AMGf_want_list) {
3415                 res = sv_2mortal((SV *)newAV());
3416                 av_extend((AV *)res, nret);
3417                 while (nret--)
3418                     av_store((AV *)res, nret, POPs);
3419                 break;
3420             }
3421             /* FALLTHROUGH */
3422         }
3423         default:
3424             res = POPs;
3425             break;
3426     }
3427
3428     PUTBACK;
3429     POPSTACK;
3430     CATCH_SET(oldcatch);
3431
3432     if (postpr) {
3433       int ans;
3434       switch (method) {
3435       case le_amg:
3436       case sle_amg:
3437         ans=SvIV(res)<=0; break;
3438       case lt_amg:
3439       case slt_amg:
3440         ans=SvIV(res)<0; break;
3441       case ge_amg:
3442       case sge_amg:
3443         ans=SvIV(res)>=0; break;
3444       case gt_amg:
3445       case sgt_amg:
3446         ans=SvIV(res)>0; break;
3447       case eq_amg:
3448       case seq_amg:
3449         ans=SvIV(res)==0; break;
3450       case ne_amg:
3451       case sne_amg:
3452         ans=SvIV(res)!=0; break;
3453       case inc_amg:
3454       case dec_amg:
3455         SvSetSV(left,res); return left;
3456       case not_amg:
3457         ans=!SvTRUE(res); break;
3458       default:
3459         ans=0; break;
3460       }
3461       return boolSV(ans);
3462     } else if (method==copy_amg) {
3463       if (!SvROK(res)) {
3464         Perl_croak(aTHX_ "Copy method did not return a reference");
3465       }
3466       return SvREFCNT_inc(SvRV(res));
3467     } else {
3468       return res;
3469     }
3470   }
3471 }
3472
3473 void
3474 Perl_gv_name_set(pTHX_ GV *gv, const char *name, U32 len, U32 flags)
3475 {
3476     dVAR;
3477     U32 hash;
3478
3479     PERL_ARGS_ASSERT_GV_NAME_SET;
3480
3481     if (len > I32_MAX)
3482         Perl_croak(aTHX_ "panic: gv name too long (%"UVuf")", (UV) len);
3483
3484     if (!(flags & GV_ADD) && GvNAME_HEK(gv)) {
3485         unshare_hek(GvNAME_HEK(gv));
3486     }
3487
3488     PERL_HASH(hash, name, len);
3489     GvNAME_HEK(gv) = share_hek(name, (flags & SVf_UTF8 ? -(I32)len : (I32)len), hash);
3490 }
3491
3492 /*
3493 =for apidoc gv_try_downgrade
3494
3495 If the typeglob C<gv> can be expressed more succinctly, by having
3496 something other than a real GV in its place in the stash, replace it
3497 with the optimised form.  Basic requirements for this are that C<gv>
3498 is a real typeglob, is sufficiently ordinary, and is only referenced
3499 from its package.  This function is meant to be used when a GV has been
3500 looked up in part to see what was there, causing upgrading, but based
3501 on what was found it turns out that the real GV isn't required after all.
3502
3503 If C<gv> is a completely empty typeglob, it is deleted from the stash.
3504
3505 If C<gv> is a typeglob containing only a sufficiently-ordinary constant
3506 sub, the typeglob is replaced with a scalar-reference placeholder that
3507 more compactly represents the same thing.
3508
3509 =cut
3510 */
3511
3512 void
3513 Perl_gv_try_downgrade(pTHX_ GV *gv)
3514 {
3515     HV *stash;
3516     CV *cv;
3517     HEK *namehek;
3518     SV **gvp;
3519     PERL_ARGS_ASSERT_GV_TRY_DOWNGRADE;
3520
3521     /* XXX Why and where does this leave dangling pointers during global
3522        destruction? */
3523     if (PL_phase == PERL_PHASE_DESTRUCT) return;
3524
3525     if (!(SvREFCNT(gv) == 1 && SvTYPE(gv) == SVt_PVGV && !SvFAKE(gv) &&
3526             !SvOBJECT(gv) && !SvREADONLY(gv) &&
3527             isGV_with_GP(gv) && GvGP(gv) &&
3528             !GvINTRO(gv) && GvREFCNT(gv) == 1 &&
3529             !GvSV(gv) && !GvAV(gv) && !GvHV(gv) && !GvIOp(gv) && !GvFORM(gv) &&
3530             GvEGVx(gv) == gv && (stash = GvSTASH(gv))))
3531         return;
3532     if (gv == PL_statgv || gv == PL_last_in_gv || gv == PL_stderrgv)
3533         return;
3534     if (SvMAGICAL(gv)) {
3535         MAGIC *mg;
3536         /* only backref magic is allowed */
3537         if (SvGMAGICAL(gv) || SvSMAGICAL(gv))
3538             return;
3539         for (mg = SvMAGIC(gv); mg; mg = mg->mg_moremagic) {
3540             if (mg->mg_type != PERL_MAGIC_backref)
3541                 return;
3542         }
3543     }
3544     cv = GvCV(gv);
3545     if (!cv) {
3546         HEK *gvnhek = GvNAME_HEK(gv);
3547         (void)hv_deletehek(stash, gvnhek, G_DISCARD);
3548     } else if (GvMULTI(gv) && cv && SvREFCNT(cv) == 1 &&
3549             !SvOBJECT(cv) && !SvMAGICAL(cv) && !SvREADONLY(cv) &&
3550             CvSTASH(cv) == stash && !CvNAMED(cv) && CvGV(cv) == gv &&
3551             CvCONST(cv) && !CvMETHOD(cv) && !CvLVALUE(cv) && !CvUNIQUE(cv) &&
3552             !CvNODEBUG(cv) && !CvCLONE(cv) && !CvCLONED(cv) && !CvANON(cv) &&
3553             (namehek = GvNAME_HEK(gv)) &&
3554             (gvp = hv_fetchhek(stash, namehek, 0)) &&
3555             *gvp == (SV*)gv) {
3556         SV *value = SvREFCNT_inc(CvXSUBANY(cv).any_ptr);
3557         const bool imported = !!GvIMPORTED_CV(gv);
3558         SvREFCNT(gv) = 0;
3559         sv_clear((SV*)gv);
3560         SvREFCNT(gv) = 1;
3561         SvFLAGS(gv) = SVt_IV|SVf_ROK|SVprv_PCS_IMPORTED * imported;
3562
3563         /* See also: 'SET_SVANY_FOR_BODYLESS_IV' in sv.c */
3564         SvANY(gv) = (XPVGV*)((char*)&(gv->sv_u.svu_iv) -
3565                                 STRUCT_OFFSET(XPVIV, xiv_iv));
3566         SvRV_set(gv, value);
3567     }
3568 }
3569
3570 GV *
3571 Perl_gv_override(pTHX_ const char * const name, const STRLEN len)
3572 {
3573     GV *gv = gv_fetchpvn(name, len, GV_NOTQUAL, SVt_PVCV);
3574     GV * const *gvp;
3575     PERL_ARGS_ASSERT_GV_OVERRIDE;
3576     if (gv && GvCVu(gv) && GvIMPORTED_CV(gv)) return gv;
3577     gvp = (GV**)hv_fetch(PL_globalstash, name, len, FALSE);
3578     gv = gvp ? *gvp : NULL;
3579     if (gv && !isGV(gv)) {
3580         if (!SvPCS_IMPORTED(gv)) return NULL;
3581         gv_init(gv, PL_globalstash, name, len, 0);
3582         return gv;
3583     }
3584     return gv && GvCVu(gv) && GvIMPORTED_CV(gv) ? gv : NULL;
3585 }
3586
3587 #include "XSUB.h"
3588
3589 static void
3590 core_xsub(pTHX_ CV* cv)
3591 {
3592     Perl_croak(aTHX_
3593        "&CORE::%s cannot be called directly", GvNAME(CvGV(cv))
3594     );
3595 }
3596
3597 /*
3598  * Local variables:
3599  * c-indentation-style: bsd
3600  * c-basic-offset: 4
3601  * indent-tabs-mode: nil
3602  * End:
3603  *
3604  * ex: set ts=8 sts=4 sw=4 et:
3605  */