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