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