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