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