Fix M::CL version
[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, const char * name,
1309                         STRLEN len, const U32 flags)
1310 {
1311     const char varname = *varpv; /* varpv might be clobbered by
1312                                     load_module, so save it.  For the
1313                                     moment it’s always a single char.  */
1314     const SV * const target = varname == '[' ? GvSV(gv) : (SV *)GvHV(gv);
1315
1316     PERL_ARGS_ASSERT_REQUIRE_TIE_MOD;
1317
1318     /* If it is not tied */
1319     if (!target || !SvRMAGICAL(target)
1320      || !mg_find(target,
1321                  varname == '[' ? PERL_MAGIC_tiedscalar : PERL_MAGIC_tied))
1322     {
1323       HV *stash;
1324       GV **gvp;
1325       dSP;
1326
1327       ENTER;
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_stashpvn(name, len, 0))
1333        || !(gvp = HV_FETCH_TIE_FUNC) || !*gvp || !GvCV(*gvp))
1334       {
1335         SV * const module = newSVpvn(name, len);
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_stashpvn(name, len, 0);
1342         if (!stash)
1343             Perl_croak(aTHX_ "panic: Can't use %c%c because %s is not available",
1344                     type, varname, name);
1345         else if (!(gvp = HV_FETCH_TIE_FUNC) || !*gvp || !GvCV(*gvp))
1346             Perl_croak(aTHX_ "panic: Can't use %c%c because %s does not define _tie_it",
1347                     type, varname, name);
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 }
1358
1359 /*
1360 =for apidoc gv_stashpv
1361
1362 Returns a pointer to the stash for a specified package.  Uses C<strlen> to
1363 determine the length of C<name>, then calls C<gv_stashpvn()>.
1364
1365 =cut
1366 */
1367
1368 HV*
1369 Perl_gv_stashpv(pTHX_ const char *name, I32 create)
1370 {
1371     PERL_ARGS_ASSERT_GV_STASHPV;
1372     return gv_stashpvn(name, strlen(name), create);
1373 }
1374
1375 /*
1376 =for apidoc gv_stashpvn
1377
1378 Returns a pointer to the stash for a specified package.  The C<namelen>
1379 parameter indicates the length of the C<name>, in bytes.  C<flags> is passed
1380 to C<gv_fetchpvn_flags()>, so if set to C<GV_ADD> then the package will be
1381 created if it does not already exist.  If the package does not exist and
1382 C<flags> is 0 (or any other setting that does not create packages) then C<NULL>
1383 is returned.
1384
1385 Flags may be one of:
1386
1387     GV_ADD
1388     SVf_UTF8
1389     GV_NOADD_NOINIT
1390     GV_NOINIT
1391     GV_NOEXPAND
1392     GV_ADDMG
1393
1394 The most important of which are probably C<GV_ADD> and C<SVf_UTF8>.
1395
1396 Note, use of C<gv_stashsv> instead of C<gv_stashpvn> where possible is strongly
1397 recommended for performance reasons.
1398
1399 =cut
1400 */
1401
1402 /*
1403 gv_stashpvn_internal
1404
1405 Perform the internal bits of gv_stashsvpvn_cached. You could think of this
1406 as being one half of the logic. Not to be called except from gv_stashsvpvn_cached().
1407
1408 */
1409
1410 PERL_STATIC_INLINE HV*
1411 S_gv_stashpvn_internal(pTHX_ const char *name, U32 namelen, I32 flags)
1412 {
1413     char smallbuf[128];
1414     char *tmpbuf;
1415     HV *stash;
1416     GV *tmpgv;
1417     U32 tmplen = namelen + 2;
1418
1419     PERL_ARGS_ASSERT_GV_STASHPVN_INTERNAL;
1420
1421     if (tmplen <= sizeof smallbuf)
1422         tmpbuf = smallbuf;
1423     else
1424         Newx(tmpbuf, tmplen, char);
1425     Copy(name, tmpbuf, namelen, char);
1426     tmpbuf[namelen]   = ':';
1427     tmpbuf[namelen+1] = ':';
1428     tmpgv = gv_fetchpvn_flags(tmpbuf, tmplen, flags, SVt_PVHV);
1429     if (tmpbuf != smallbuf)
1430         Safefree(tmpbuf);
1431     if (!tmpgv || !isGV_with_GP(tmpgv))
1432         return NULL;
1433     stash = GvHV(tmpgv);
1434     if (!(flags & ~GV_NOADD_MASK) && !stash) return NULL;
1435     assert(stash);
1436     if (!HvNAME_get(stash)) {
1437         hv_name_set(stash, name, namelen, flags & SVf_UTF8 ? SVf_UTF8 : 0 );
1438         
1439         /* FIXME: This is a repeat of logic in gv_fetchpvn_flags */
1440         /* If the containing stash has multiple effective
1441            names, see that this one gets them, too. */
1442         if (HvAUX(GvSTASH(tmpgv))->xhv_name_count)
1443             mro_package_moved(stash, NULL, tmpgv, 1);
1444     }
1445     return stash;
1446 }
1447
1448 /*
1449 gv_stashsvpvn_cached
1450
1451 Returns a pointer to the stash for a specified package, possibly
1452 cached.  Implements both C<gv_stashpvn> and C<gv_stashsv>.
1453
1454 Requires one of either namesv or namepv to be non-null.
1455
1456 See C<L</gv_stashpvn>> for details on "flags".
1457
1458 Note the sv interface is strongly preferred for performance reasons.
1459
1460 */
1461
1462 #define PERL_ARGS_ASSERT_GV_STASHSVPVN_CACHED \
1463     assert(namesv || name)
1464
1465 PERL_STATIC_INLINE HV*
1466 S_gv_stashsvpvn_cached(pTHX_ SV *namesv, const char *name, U32 namelen, I32 flags)
1467 {
1468     HV* stash;
1469     HE* he;
1470
1471     PERL_ARGS_ASSERT_GV_STASHSVPVN_CACHED;
1472
1473     he = (HE *)hv_common(
1474         PL_stashcache, namesv, name, namelen,
1475         (flags & SVf_UTF8) ? HVhek_UTF8 : 0, 0, NULL, 0
1476     );
1477
1478     if (he) return INT2PTR(HV*,SvIVX(HeVAL(he)));
1479     else if (flags & GV_CACHE_ONLY) return NULL;
1480
1481     if (namesv) {
1482         if (SvOK(namesv)) { /* prevent double uninit warning */
1483             STRLEN len;
1484             name = SvPV_const(namesv, len);
1485             namelen = len;
1486             flags |= SvUTF8(namesv);
1487         } else {
1488             name = ""; namelen = 0;
1489         }
1490     }
1491     stash = gv_stashpvn_internal(name, namelen, flags);
1492
1493     if (stash && namelen) {
1494         SV* const ref = newSViv(PTR2IV(stash));
1495         (void)hv_store(PL_stashcache, name,
1496             (flags & SVf_UTF8) ? -(I32)namelen : (I32)namelen, ref, 0);
1497     }
1498
1499     return stash;
1500 }
1501
1502 HV*
1503 Perl_gv_stashpvn(pTHX_ const char *name, U32 namelen, I32 flags)
1504 {
1505     PERL_ARGS_ASSERT_GV_STASHPVN;
1506     return gv_stashsvpvn_cached(NULL, name, namelen, flags);
1507 }
1508
1509 /*
1510 =for apidoc gv_stashsv
1511
1512 Returns a pointer to the stash for a specified package.  See
1513 C<L</gv_stashpvn>>.
1514
1515 Note this interface is strongly preferred over C<gv_stashpvn> for performance
1516 reasons.
1517
1518 =cut
1519 */
1520
1521 HV*
1522 Perl_gv_stashsv(pTHX_ SV *sv, I32 flags)
1523 {
1524     PERL_ARGS_ASSERT_GV_STASHSV;
1525     return gv_stashsvpvn_cached(sv, NULL, 0, flags);
1526 }
1527
1528
1529 GV *
1530 Perl_gv_fetchpv(pTHX_ const char *nambeg, I32 add, const svtype sv_type) {
1531     PERL_ARGS_ASSERT_GV_FETCHPV;
1532     return gv_fetchpvn_flags(nambeg, strlen(nambeg), add, sv_type);
1533 }
1534
1535 GV *
1536 Perl_gv_fetchsv(pTHX_ SV *name, I32 flags, const svtype sv_type) {
1537     STRLEN len;
1538     const char * const nambeg =
1539        SvPV_flags_const(name, len, flags & GV_NO_SVGMAGIC ? 0 : SV_GMAGIC);
1540     PERL_ARGS_ASSERT_GV_FETCHSV;
1541     return gv_fetchpvn_flags(nambeg, len, flags | SvUTF8(name), sv_type);
1542 }
1543
1544 PERL_STATIC_INLINE void
1545 S_gv_magicalize_isa(pTHX_ GV *gv)
1546 {
1547     AV* av;
1548
1549     PERL_ARGS_ASSERT_GV_MAGICALIZE_ISA;
1550
1551     av = GvAVn(gv);
1552     GvMULTI_on(gv);
1553     sv_magic(MUTABLE_SV(av), MUTABLE_SV(gv), PERL_MAGIC_isa,
1554              NULL, 0);
1555 }
1556
1557 /* This function grabs name and tries to split a stash and glob
1558  * from its contents. TODO better description, comments
1559  * 
1560  * If the function returns TRUE and 'name == name_end', then
1561  * 'gv' can be directly returned to the caller of gv_fetchpvn_flags
1562  */
1563 PERL_STATIC_INLINE bool
1564 S_parse_gv_stash_name(pTHX_ HV **stash, GV **gv, const char **name,
1565                STRLEN *len, const char *nambeg, STRLEN full_len,
1566                const U32 is_utf8, const I32 add)
1567 {
1568     const char *name_cursor;
1569     const char *const name_end = nambeg + full_len;
1570     const char *const name_em1 = name_end - 1;
1571
1572     PERL_ARGS_ASSERT_PARSE_GV_STASH_NAME;
1573     
1574     if (full_len > 2 && **name == '*' && isIDFIRST_lazy_if(*name + 1, is_utf8)) {
1575         /* accidental stringify on a GV? */
1576         (*name)++;
1577     }
1578
1579     for (name_cursor = *name; name_cursor < name_end; name_cursor++) {
1580         if (name_cursor < name_em1 &&
1581             ((*name_cursor == ':' && name_cursor[1] == ':')
1582            || *name_cursor == '\''))
1583         {
1584             if (!*stash)
1585                 *stash = PL_defstash;
1586             if (!*stash || !SvREFCNT(*stash)) /* symbol table under destruction */
1587                 return FALSE;
1588
1589             *len = name_cursor - *name;
1590             if (name_cursor > nambeg) { /* Skip for initial :: or ' */
1591                 const char *key;
1592                 GV**gvp;
1593                 if (*name_cursor == ':') {
1594                     key = *name;
1595                     *len += 2;
1596                 }
1597                 else {
1598                     char *tmpbuf;
1599                     Newx(tmpbuf, *len+2, char);
1600                     Copy(*name, tmpbuf, *len, char);
1601                     tmpbuf[(*len)++] = ':';
1602                     tmpbuf[(*len)++] = ':';
1603                     key = tmpbuf;
1604                 }
1605                 gvp = (GV**)hv_fetch(*stash, key, is_utf8 ? -((I32)*len) : (I32)*len, add);
1606                 *gv = gvp ? *gvp : NULL;
1607                 if (*gv && *gv != (const GV *)&PL_sv_undef) {
1608                     if (SvTYPE(*gv) != SVt_PVGV)
1609                         gv_init_pvn(*gv, *stash, key, *len, (add & GV_ADDMULTI)|is_utf8);
1610                     else
1611                         GvMULTI_on(*gv);
1612                 }
1613                 if (key != *name)
1614                     Safefree(key);
1615                 if (!*gv || *gv == (const GV *)&PL_sv_undef)
1616                     return FALSE;
1617
1618                 if (!(*stash = GvHV(*gv))) {
1619                     *stash = GvHV(*gv) = newHV();
1620                     if (!HvNAME_get(*stash)) {
1621                         if (GvSTASH(*gv) == PL_defstash && *len == 6
1622                             && strnEQ(*name, "CORE", 4))
1623                             hv_name_set(*stash, "CORE", 4, 0);
1624                         else
1625                             hv_name_set(
1626                                 *stash, nambeg, name_cursor-nambeg, is_utf8
1627                             );
1628                     /* If the containing stash has multiple effective
1629                     names, see that this one gets them, too. */
1630                     if (HvAUX(GvSTASH(*gv))->xhv_name_count)
1631                         mro_package_moved(*stash, NULL, *gv, 1);
1632                     }
1633                 }
1634                 else if (!HvNAME_get(*stash))
1635                     hv_name_set(*stash, nambeg, name_cursor - nambeg, is_utf8);
1636             }
1637
1638             if (*name_cursor == ':')
1639                 name_cursor++;
1640             *name = name_cursor+1;
1641             if (*name == name_end) {
1642                 if (!*gv)
1643                     *gv = MUTABLE_GV(*hv_fetchs(PL_defstash, "main::", TRUE));
1644                 return TRUE;
1645             }
1646         }
1647     }
1648     *len = name_cursor - *name;
1649     return TRUE;
1650 }
1651
1652 /* Checks if an unqualified name is in the main stash */
1653 PERL_STATIC_INLINE bool
1654 S_gv_is_in_main(pTHX_ const char *name, STRLEN len, const U32 is_utf8)
1655 {
1656     PERL_ARGS_ASSERT_GV_IS_IN_MAIN;
1657     
1658     /* If it's an alphanumeric variable */
1659     if ( len && isIDFIRST_lazy_if(name, is_utf8) ) {
1660         /* Some "normal" variables are always in main::,
1661          * like INC or STDOUT.
1662          */
1663         switch (len) {
1664             case 1:
1665             if (*name == '_')
1666                 return TRUE;
1667             break;
1668             case 3:
1669             if ((name[0] == 'I' && name[1] == 'N' && name[2] == 'C')
1670                 || (name[0] == 'E' && name[1] == 'N' && name[2] == 'V')
1671                 || (name[0] == 'S' && name[1] == 'I' && name[2] == 'G'))
1672                 return TRUE;
1673             break;
1674             case 4:
1675             if (name[0] == 'A' && name[1] == 'R' && name[2] == 'G'
1676                 && name[3] == 'V')
1677                 return TRUE;
1678             break;
1679             case 5:
1680             if (name[0] == 'S' && name[1] == 'T' && name[2] == 'D'
1681                 && name[3] == 'I' && name[4] == 'N')
1682                 return TRUE;
1683             break;
1684             case 6:
1685             if ((name[0] == 'S' && name[1] == 'T' && name[2] == 'D')
1686                 &&((name[3] == 'O' && name[4] == 'U' && name[5] == 'T')
1687                     ||(name[3] == 'E' && name[4] == 'R' && name[5] == 'R')))
1688                 return TRUE;
1689             break;
1690             case 7:
1691             if (name[0] == 'A' && name[1] == 'R' && name[2] == 'G'
1692                 && name[3] == 'V' && name[4] == 'O' && name[5] == 'U'
1693                 && name[6] == 'T')
1694                 return TRUE;
1695             break;
1696         }
1697     }
1698     /* *{""}, or a special variable like $@ */
1699     else
1700         return TRUE;
1701     
1702     return FALSE;
1703 }
1704
1705
1706 /* This function is called if parse_gv_stash_name() failed to
1707  * find a stash, or if GV_NOTQUAL or an empty name was passed
1708  * to gv_fetchpvn_flags.
1709  * 
1710  * It returns FALSE if the default stash can't be found nor created,
1711  * which might happen during global destruction.
1712  */
1713 PERL_STATIC_INLINE bool
1714 S_find_default_stash(pTHX_ HV **stash, const char *name, STRLEN len,
1715                const U32 is_utf8, const I32 add,
1716                const svtype sv_type)
1717 {
1718     PERL_ARGS_ASSERT_FIND_DEFAULT_STASH;
1719     
1720     /* No stash in name, so see how we can default */
1721
1722     if ( gv_is_in_main(name, len, is_utf8) ) {
1723         *stash = PL_defstash;
1724     }
1725     else {
1726         if (IN_PERL_COMPILETIME) {
1727             *stash = PL_curstash;
1728             if (add && (PL_hints & HINT_STRICT_VARS) &&
1729                 sv_type != SVt_PVCV &&
1730                 sv_type != SVt_PVGV &&
1731                 sv_type != SVt_PVFM &&
1732                 sv_type != SVt_PVIO &&
1733                 !(len == 1 && sv_type == SVt_PV &&
1734                 (*name == 'a' || *name == 'b')) )
1735             {
1736                 GV**gvp = (GV**)hv_fetch(*stash,name,is_utf8 ? -(I32)len : (I32)len,0);
1737                 if (!gvp || *gvp == (const GV *)&PL_sv_undef ||
1738                     SvTYPE(*gvp) != SVt_PVGV)
1739                 {
1740                     *stash = NULL;
1741                 }
1742                 else if ((sv_type == SVt_PV   && !GvIMPORTED_SV(*gvp)) ||
1743                          (sv_type == SVt_PVAV && !GvIMPORTED_AV(*gvp)) ||
1744                          (sv_type == SVt_PVHV && !GvIMPORTED_HV(*gvp)) )
1745                 {
1746                     /* diag_listed_as: Variable "%s" is not imported%s */
1747                     Perl_ck_warner_d(
1748                         aTHX_ packWARN(WARN_MISC),
1749                         "Variable \"%c%"UTF8f"\" is not imported",
1750                         sv_type == SVt_PVAV ? '@' :
1751                         sv_type == SVt_PVHV ? '%' : '$',
1752                         UTF8fARG(is_utf8, len, name));
1753                     if (GvCVu(*gvp))
1754                         Perl_ck_warner_d(
1755                             aTHX_ packWARN(WARN_MISC),
1756                             "\t(Did you mean &%"UTF8f" instead?)\n",
1757                             UTF8fARG(is_utf8, len, name)
1758                         );
1759                     *stash = NULL;
1760                 }
1761             }
1762         }
1763         else {
1764             /* Use the current op's stash */
1765             *stash = CopSTASH(PL_curcop);
1766         }
1767     }
1768
1769     if (!*stash) {
1770         if (add && !PL_in_clean_all) {
1771             GV *gv;
1772             qerror(Perl_mess(aTHX_
1773                  "Global symbol \"%s%"UTF8f
1774                  "\" requires explicit package name (did you forget to "
1775                  "declare \"my %s%"UTF8f"\"?)",
1776                  (sv_type == SVt_PV ? "$"
1777                   : sv_type == SVt_PVAV ? "@"
1778                   : sv_type == SVt_PVHV ? "%"
1779                   : ""), UTF8fARG(is_utf8, len, name),
1780                  (sv_type == SVt_PV ? "$"
1781                   : sv_type == SVt_PVAV ? "@"
1782                   : sv_type == SVt_PVHV ? "%"
1783                   : ""), UTF8fARG(is_utf8, len, name)));
1784             /* To maintain the output of errors after the strict exception
1785              * above, and to keep compat with older releases, rather than
1786              * placing the variables in the pad, we place
1787              * them in the <none>:: stash.
1788              */
1789             gv = gv_fetchpvs("<none>::", GV_ADDMULTI, SVt_PVHV);
1790             if (!gv) {
1791                 /* symbol table under destruction */
1792                 return FALSE;
1793             }
1794             *stash = GvHV(gv);
1795         }
1796         else
1797             return FALSE;
1798     }
1799
1800     if (!SvREFCNT(*stash))   /* symbol table under destruction */
1801         return FALSE;
1802
1803     return TRUE;
1804 }
1805
1806 /* gv_magicalize only turns on the SVf_READONLY flag, not SVf_PROTECT.  So
1807    redefine SvREADONLY_on for that purpose.  We don’t use it later on in
1808    this file.  */
1809 #undef SvREADONLY_on
1810 #define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
1811
1812 /* gv_magicalize() is called by gv_fetchpvn_flags when creating
1813  * a new GV.
1814  * Note that it does not insert the GV into the stash prior to
1815  * magicalization, which some variables require need in order
1816  * to work (like $[, %+, %-, %!), so callers must take care of
1817  * that.
1818  * 
1819  * It returns true if the gv did turn out to be magical one; i.e.,
1820  * if gv_magicalize actually did something.
1821  */
1822 PERL_STATIC_INLINE bool
1823 S_gv_magicalize(pTHX_ GV *gv, HV *stash, const char *name, STRLEN len,
1824                       const svtype sv_type)
1825 {
1826     SSize_t paren;
1827
1828     PERL_ARGS_ASSERT_GV_MAGICALIZE;
1829     
1830     if (stash != PL_defstash) { /* not the main stash */
1831         /* We only have to check for a few names here: a, b, EXPORT, ISA
1832            and VERSION. All the others apply only to the main stash or to
1833            CORE (which is checked right after this). */
1834         if (len) {
1835             const char * const name2 = name + 1;
1836             switch (*name) {
1837             case 'E':
1838                 if (strnEQ(name2, "XPORT", 5))
1839                     GvMULTI_on(gv);
1840                 break;
1841             case 'I':
1842                 if (strEQ(name2, "SA"))
1843                     gv_magicalize_isa(gv);
1844                 break;
1845             case 'V':
1846                 if (strEQ(name2, "ERSION"))
1847                     GvMULTI_on(gv);
1848                 break;
1849             case 'a':
1850                 if (stash == PL_debstash && len==4 && strEQ(name2,"rgs")) {
1851                     GvMULTI_on(gv_AVadd(gv));
1852                     break;
1853                 }
1854             case 'b':
1855                 if (len == 1 && sv_type == SVt_PV)
1856                     GvMULTI_on(gv);
1857                 /* FALLTHROUGH */
1858             default:
1859                 goto try_core;
1860             }
1861             goto ret;
1862         }
1863       try_core:
1864         if (len > 1 /* shortest is uc */ && HvNAMELEN_get(stash) == 4) {
1865           /* Avoid null warning: */
1866           const char * const stashname = HvNAME(stash); assert(stashname);
1867           if (strnEQ(stashname, "CORE", 4))
1868             S_maybe_add_coresub(aTHX_ 0, gv, name, len);
1869         }
1870     }
1871     else if (len > 1) {
1872 #ifndef EBCDIC
1873         if (*name > 'V' ) {
1874             NOOP;
1875             /* Nothing else to do.
1876                The compiler will probably turn the switch statement into a
1877                branch table. Make sure we avoid even that small overhead for
1878                the common case of lower case variable names.  (On EBCDIC
1879                platforms, we can't just do:
1880                  if (NATIVE_TO_ASCII(*name) > NATIVE_TO_ASCII('V') ) {
1881                because cases like '\027' in the switch statement below are
1882                C1 (non-ASCII) controls on those platforms, so the remapping
1883                would make them larger than 'V')
1884              */
1885         } else
1886 #endif
1887         {
1888             const char * name2 = name + 1;
1889             switch (*name) {
1890             case 'A':
1891                 if (strEQ(name2, "RGV")) {
1892                     IoFLAGS(GvIOn(gv)) |= IOf_ARGV|IOf_START;
1893                 }
1894                 else if (strEQ(name2, "RGVOUT")) {
1895                     GvMULTI_on(gv);
1896                 }
1897                 break;
1898             case 'E':
1899                 if (strnEQ(name2, "XPORT", 5))
1900                     GvMULTI_on(gv);
1901                 break;
1902             case 'I':
1903                 if (strEQ(name2, "SA")) {
1904                     gv_magicalize_isa(gv);
1905                 }
1906                 break;
1907             case 'S':
1908                 if (strEQ(name2, "IG")) {
1909                     HV *hv;
1910                     I32 i;
1911                     if (!PL_psig_name) {
1912                         Newxz(PL_psig_name, 2 * SIG_SIZE, SV*);
1913                         Newxz(PL_psig_pend, SIG_SIZE, int);
1914                         PL_psig_ptr = PL_psig_name + SIG_SIZE;
1915                     } else {
1916                         /* I think that the only way to get here is to re-use an
1917                            embedded perl interpreter, where the previous
1918                            use didn't clean up fully because
1919                            PL_perl_destruct_level was 0. I'm not sure that we
1920                            "support" that, in that I suspect in that scenario
1921                            there are sufficient other garbage values left in the
1922                            interpreter structure that something else will crash
1923                            before we get here. I suspect that this is one of
1924                            those "doctor, it hurts when I do this" bugs.  */
1925                         Zero(PL_psig_name, 2 * SIG_SIZE, SV*);
1926                         Zero(PL_psig_pend, SIG_SIZE, int);
1927                     }
1928                     GvMULTI_on(gv);
1929                     hv = GvHVn(gv);
1930                     hv_magic(hv, NULL, PERL_MAGIC_sig);
1931                     for (i = 1; i < SIG_SIZE; i++) {
1932                         SV * const * const init = hv_fetch(hv, PL_sig_name[i], strlen(PL_sig_name[i]), 1);
1933                         if (init)
1934                             sv_setsv(*init, &PL_sv_undef);
1935                     }
1936                 }
1937                 break;
1938             case 'V':
1939                 if (strEQ(name2, "ERSION"))
1940                     GvMULTI_on(gv);
1941                 break;
1942             case '\003':        /* $^CHILD_ERROR_NATIVE */
1943                 if (strEQ(name2, "HILD_ERROR_NATIVE"))
1944                     goto magicalize;
1945                 break;
1946             case '\005':        /* $^ENCODING */
1947                 if (strEQ(name2, "NCODING"))
1948                     goto magicalize;
1949                 break;
1950             case '\007':        /* $^GLOBAL_PHASE */
1951                 if (strEQ(name2, "LOBAL_PHASE"))
1952                     goto ro_magicalize;
1953                 break;
1954             case '\014':        /* $^LAST_FH */
1955                 if (strEQ(name2, "AST_FH"))
1956                     goto ro_magicalize;
1957                 break;
1958             case '\015':        /* $^MATCH */
1959                 if (strEQ(name2, "ATCH")) {
1960                     paren = RX_BUFF_IDX_CARET_FULLMATCH;
1961                     goto storeparen;
1962                 }
1963                 break;
1964             case '\017':        /* $^OPEN */
1965                 if (strEQ(name2, "PEN"))
1966                     goto magicalize;
1967                 break;
1968             case '\020':        /* $^PREMATCH  $^POSTMATCH */
1969                 if (strEQ(name2, "REMATCH")) {
1970                     paren = RX_BUFF_IDX_CARET_PREMATCH;
1971                     goto storeparen;
1972                 }
1973                 if (strEQ(name2, "OSTMATCH")) {
1974                     paren = RX_BUFF_IDX_CARET_POSTMATCH;
1975                     goto storeparen;
1976                 }
1977                 break;
1978             case '\024':        /* ${^TAINT} */
1979                 if (strEQ(name2, "AINT"))
1980                     goto ro_magicalize;
1981                 break;
1982             case '\025':        /* ${^UNICODE}, ${^UTF8LOCALE} */
1983                 if (strEQ(name2, "NICODE"))
1984                     goto ro_magicalize;
1985                 if (strEQ(name2, "TF8LOCALE"))
1986                     goto ro_magicalize;
1987                 if (strEQ(name2, "TF8CACHE"))
1988                     goto magicalize;
1989                 break;
1990             case '\027':        /* $^WARNING_BITS */
1991                 if (strEQ(name2, "ARNING_BITS"))
1992                     goto magicalize;
1993 #ifdef WIN32
1994                 else if (strEQ(name2, "IN32_SLOPPY_STAT"))
1995                     goto magicalize;
1996 #endif
1997                 break;
1998             case '1':
1999             case '2':
2000             case '3':
2001             case '4':
2002             case '5':
2003             case '6':
2004             case '7':
2005             case '8':
2006             case '9':
2007             {
2008                 /* Ensures that we have an all-digit variable, ${"1foo"} fails
2009                    this test  */
2010                 UV uv;
2011                 if (!grok_atoUV(name, &uv, NULL) || uv > I32_MAX)
2012                     goto ret;
2013                 /* XXX why are we using a SSize_t? */
2014                 paren = (SSize_t)(I32)uv;
2015                 goto storeparen;
2016             }
2017             }
2018         }
2019     } else {
2020         /* Names of length 1.  (Or 0. But name is NUL terminated, so that will
2021            be case '\0' in this switch statement (ie a default case)  */
2022         switch (*name) {
2023         case '&':               /* $& */
2024             paren = RX_BUFF_IDX_FULLMATCH;
2025             goto sawampersand;
2026         case '`':               /* $` */
2027             paren = RX_BUFF_IDX_PREMATCH;
2028             goto sawampersand;
2029         case '\'':              /* $' */
2030             paren = RX_BUFF_IDX_POSTMATCH;
2031         sawampersand:
2032 #ifdef PERL_SAWAMPERSAND
2033             if (!(
2034                 sv_type == SVt_PVAV ||
2035                 sv_type == SVt_PVHV ||
2036                 sv_type == SVt_PVCV ||
2037                 sv_type == SVt_PVFM ||
2038                 sv_type == SVt_PVIO
2039                 )) { PL_sawampersand |=
2040                         (*name == '`')
2041                             ? SAWAMPERSAND_LEFT
2042                             : (*name == '&')
2043                                 ? SAWAMPERSAND_MIDDLE
2044                                 : SAWAMPERSAND_RIGHT;
2045                 }
2046 #endif
2047             goto storeparen;
2048         case '1':               /* $1 */
2049         case '2':               /* $2 */
2050         case '3':               /* $3 */
2051         case '4':               /* $4 */
2052         case '5':               /* $5 */
2053         case '6':               /* $6 */
2054         case '7':               /* $7 */
2055         case '8':               /* $8 */
2056         case '9':               /* $9 */
2057             paren = *name - '0';
2058
2059         storeparen:
2060             /* Flag the capture variables with a NULL mg_ptr
2061                Use mg_len for the array index to lookup.  */
2062             sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, NULL, paren);
2063             break;
2064
2065         case ':':               /* $: */
2066             sv_setpv(GvSVn(gv),PL_chopset);
2067             goto magicalize;
2068
2069         case '?':               /* $? */
2070 #ifdef COMPLEX_STATUS
2071             SvUPGRADE(GvSVn(gv), SVt_PVLV);
2072 #endif
2073             goto magicalize;
2074
2075         case '!':               /* $! */
2076             GvMULTI_on(gv);
2077             /* If %! has been used, automatically load Errno.pm. */
2078
2079             sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
2080
2081             /* magicalization must be done before require_tie_mod is called */
2082             if (sv_type == SVt_PVHV || sv_type == SVt_PVGV)
2083                 require_tie_mod(gv, "!", "Errno", 5, 1);
2084
2085             break;
2086         case '-':               /* $- */
2087         case '+':               /* $+ */
2088         GvMULTI_on(gv); /* no used once warnings here */
2089         {
2090             AV* const av = GvAVn(gv);
2091             SV* const avc = (*name == '+') ? MUTABLE_SV(av) : NULL;
2092
2093             sv_magic(MUTABLE_SV(av), avc, PERL_MAGIC_regdata, NULL, 0);
2094             sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
2095             if (avc)
2096                 SvREADONLY_on(GvSVn(gv));
2097             SvREADONLY_on(av);
2098
2099             if (sv_type == SVt_PVHV || sv_type == SVt_PVGV)
2100                 require_tie_mod(gv, name, "Tie::Hash::NamedCapture",23, 0);
2101
2102             break;
2103         }
2104         case '*':               /* $* */
2105         case '#':               /* $# */
2106             if (sv_type == SVt_PV)
2107                 /* diag_listed_as: $* is no longer supported */
2108                 Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_SYNTAX),
2109                                  "$%c is no longer supported", *name);
2110             break;
2111         case '\010':    /* $^H */
2112             {
2113                 HV *const hv = GvHVn(gv);
2114                 hv_magic(hv, NULL, PERL_MAGIC_hints);
2115             }
2116             goto magicalize;
2117         case '[':               /* $[ */
2118             if ((sv_type == SVt_PV || sv_type == SVt_PVGV)
2119              && FEATURE_ARYBASE_IS_ENABLED) {
2120                 require_tie_mod(gv,name,"arybase",7,0);
2121             }
2122             else goto magicalize;
2123             break;
2124         case '\023':    /* $^S */
2125         ro_magicalize:
2126             SvREADONLY_on(GvSVn(gv));
2127             /* FALLTHROUGH */
2128         case '0':               /* $0 */
2129         case '^':               /* $^ */
2130         case '~':               /* $~ */
2131         case '=':               /* $= */
2132         case '%':               /* $% */
2133         case '.':               /* $. */
2134         case '(':               /* $( */
2135         case ')':               /* $) */
2136         case '<':               /* $< */
2137         case '>':               /* $> */
2138         case '\\':              /* $\ */
2139         case '/':               /* $/ */
2140         case '|':               /* $| */
2141         case '$':               /* $$ */
2142         case '\001':    /* $^A */
2143         case '\003':    /* $^C */
2144         case '\004':    /* $^D */
2145         case '\005':    /* $^E */
2146         case '\006':    /* $^F */
2147         case '\011':    /* $^I, NOT \t in EBCDIC */
2148         case '\016':    /* $^N */
2149         case '\017':    /* $^O */
2150         case '\020':    /* $^P */
2151         case '\024':    /* $^T */
2152         case '\027':    /* $^W */
2153         magicalize:
2154             sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
2155             break;
2156
2157         case '\014':    /* $^L */
2158             sv_setpvs(GvSVn(gv),"\f");
2159             break;
2160         case ';':               /* $; */
2161             sv_setpvs(GvSVn(gv),"\034");
2162             break;
2163         case ']':               /* $] */
2164         {
2165             SV * const sv = GvSV(gv);
2166             if (!sv_derived_from(PL_patchlevel, "version"))
2167                 upg_version(PL_patchlevel, TRUE);
2168             GvSV(gv) = vnumify(PL_patchlevel);
2169             SvREADONLY_on(GvSV(gv));
2170             SvREFCNT_dec(sv);
2171         }
2172         break;
2173         case '\026':    /* $^V */
2174         {
2175             SV * const sv = GvSV(gv);
2176             GvSV(gv) = new_version(PL_patchlevel);
2177             SvREADONLY_on(GvSV(gv));
2178             SvREFCNT_dec(sv);
2179         }
2180         break;
2181         case 'a':
2182         case 'b':
2183             if (sv_type == SVt_PV)
2184                 GvMULTI_on(gv);
2185         }
2186     }
2187
2188    ret:
2189     /* Return true if we actually did something.  */
2190     return GvAV(gv) || GvHV(gv) || GvIO(gv) || GvCV(gv)
2191         || ( GvSV(gv) && (
2192                            SvOK(GvSV(gv)) || SvMAGICAL(GvSV(gv))
2193                          )
2194            );
2195 }
2196
2197 /* If we do ever start using this later on in the file, we need to make
2198    sure we don’t accidentally use the wrong definition.  */
2199 #undef SvREADONLY_on
2200
2201 /* This function is called when the stash already holds the GV of the magic
2202  * variable we're looking for, but we need to check that it has the correct
2203  * kind of magic.  For example, if someone first uses $! and then %!, the
2204  * latter would end up here, and we add the Errno tie to the HASH slot of
2205  * the *! glob.
2206  */
2207 PERL_STATIC_INLINE void
2208 S_maybe_multimagic_gv(pTHX_ GV *gv, const char *name, const svtype sv_type)
2209 {
2210     PERL_ARGS_ASSERT_MAYBE_MULTIMAGIC_GV;
2211
2212     if (sv_type == SVt_PVHV || sv_type == SVt_PVGV) {
2213         if (*name == '!')
2214             require_tie_mod(gv, "!", "Errno", 5, 1);
2215         else if (*name == '-' || *name == '+')
2216             require_tie_mod(gv, name, "Tie::Hash::NamedCapture", 23, 0);
2217     } else if (sv_type == SVt_PV) {
2218         if (*name == '*' || *name == '#') {
2219             /* diag_listed_as: $* is no longer supported */
2220             Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED,
2221                                              WARN_SYNTAX),
2222                              "$%c is no longer supported", *name);
2223         }
2224     }
2225     if (sv_type==SVt_PV || sv_type==SVt_PVGV) {
2226       switch (*name) {
2227       case '[':
2228           require_tie_mod(gv,name,"arybase",7,0);
2229           break;
2230 #ifdef PERL_SAWAMPERSAND
2231       case '`':
2232           PL_sawampersand |= SAWAMPERSAND_LEFT;
2233           (void)GvSVn(gv);
2234           break;
2235       case '&':
2236           PL_sawampersand |= SAWAMPERSAND_MIDDLE;
2237           (void)GvSVn(gv);
2238           break;
2239       case '\'':
2240           PL_sawampersand |= SAWAMPERSAND_RIGHT;
2241           (void)GvSVn(gv);
2242           break;
2243 #endif
2244       }
2245     }
2246 }
2247
2248 GV *
2249 Perl_gv_fetchpvn_flags(pTHX_ const char *nambeg, STRLEN full_len, I32 flags,
2250                        const svtype sv_type)
2251 {
2252     const char *name = nambeg;
2253     GV *gv = NULL;
2254     GV**gvp;
2255     STRLEN len;
2256     HV *stash = NULL;
2257     const I32 no_init = flags & (GV_NOADD_NOINIT | GV_NOINIT);
2258     const I32 no_expand = flags & GV_NOEXPAND;
2259     const I32 add = flags & ~GV_NOADD_MASK;
2260     const U32 is_utf8 = flags & SVf_UTF8;
2261     bool addmg = cBOOL(flags & GV_ADDMG);
2262     const char *const name_end = nambeg + full_len;
2263     U32 faking_it;
2264
2265     PERL_ARGS_ASSERT_GV_FETCHPVN_FLAGS;
2266
2267      /* If we have GV_NOTQUAL, the caller promised that
2268       * there is no stash, so we can skip the check.
2269       * Similarly if full_len is 0, since then we're
2270       * dealing with something like *{""} or ""->foo()
2271       */
2272     if ((flags & GV_NOTQUAL) || !full_len) {
2273         len = full_len;
2274     }
2275     else if (parse_gv_stash_name(&stash, &gv, &name, &len, nambeg, full_len, is_utf8, add)) {
2276         if (name == name_end) return gv;
2277     }
2278     else {
2279         return NULL;
2280     }
2281
2282     if (!stash && !find_default_stash(&stash, name, len, is_utf8, add, sv_type)) {
2283         return NULL;
2284     }
2285     
2286     /* By this point we should have a stash and a name */
2287     gvp = (GV**)hv_fetch(stash,name,is_utf8 ? -(I32)len : (I32)len,add);
2288     if (!gvp || *gvp == (const GV *)&PL_sv_undef) {
2289         if (addmg) gv = (GV *)newSV(0);
2290         else return NULL;
2291     }
2292     else gv = *gvp, addmg = 0;
2293     /* From this point on, addmg means gv has not been inserted in the
2294        symtab yet. */
2295
2296     if (SvTYPE(gv) == SVt_PVGV) {
2297         /* The GV already exists, so return it, but check if we need to do
2298          * anything else with it before that.
2299          */
2300         if (add) {
2301             /* This is the heuristic that handles if a variable triggers the
2302              * 'used only once' warning.  If there's already a GV in the stash
2303              * with this name, then we assume that the variable has been used
2304              * before and turn its MULTI flag on.
2305              * It's a heuristic because it can easily be "tricked", like with
2306              * BEGIN { $a = 1; $::{foo} = *a }; () = $foo
2307              * not warning about $main::foo being used just once
2308              */
2309             GvMULTI_on(gv);
2310             gv_init_svtype(gv, sv_type);
2311             /* You reach this path once the typeglob has already been created,
2312                either by the same or a different sigil.  If this path didn't
2313                exist, then (say) referencing $! first, and %! second would
2314                mean that %! was not handled correctly.  */
2315             if (len == 1 && stash == PL_defstash) {
2316                 maybe_multimagic_gv(gv, name, sv_type);
2317             }
2318             else if (len == 3 && sv_type == SVt_PVAV
2319                   && strnEQ(name, "ISA", 3)
2320                   && (!GvAV(gv) || !SvSMAGICAL(GvAV(gv))))
2321                 gv_magicalize_isa(gv);
2322         }
2323         return gv;
2324     } else if (no_init) {
2325         assert(!addmg);
2326         return gv;
2327     }
2328     /* If GV_NOEXPAND is true and what we got off the stash is a ref,
2329      * don't expand it to a glob. This is an optimization so that things
2330      * copying constants over, like Exporter, don't have to be rewritten
2331      * to take into account that you can store more than just globs in
2332      * stashes.
2333      */
2334     else if (no_expand && SvROK(gv)) {
2335         assert(!addmg);
2336         return gv;
2337     }
2338
2339     /* Adding a new symbol.
2340        Unless of course there was already something non-GV here, in which case
2341        we want to behave as if there was always a GV here, containing some sort
2342        of subroutine.
2343        Otherwise we run the risk of creating things like GvIO, which can cause
2344        subtle bugs. eg the one that tripped up SQL::Translator  */
2345
2346     faking_it = SvOK(gv);
2347
2348     if (add & GV_ADDWARN)
2349         Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
2350                 "Had to create %"UTF8f" unexpectedly",
2351                  UTF8fARG(is_utf8, name_end-nambeg, nambeg));
2352     gv_init_pvn(gv, stash, name, len, (add & GV_ADDMULTI)|is_utf8);
2353
2354     if ( isIDFIRST_lazy_if(name, is_utf8) && !ckWARN(WARN_ONCE) )
2355         GvMULTI_on(gv) ;
2356
2357     /* set up magic where warranted */
2358     if ( gv_magicalize(gv, stash, name, len, sv_type) ) {
2359         /* See 23496c6 */
2360         if (addmg) {
2361                 /* gv_magicalize magicalised this gv, so we want it
2362                  * stored in the symtab.
2363                  * Effectively the caller is asking, ‘Does this gv exist?’ 
2364                  * And we respond, ‘Er, *now* it does!’
2365                  */
2366                 (void)hv_store(stash,name,len,(SV *)gv,0);
2367         }
2368     }
2369     else if (addmg) {
2370                 /* The temporary GV created above */
2371                 SvREFCNT_dec_NN(gv);
2372                 gv = NULL;
2373     }
2374     
2375     if (gv) gv_init_svtype(gv, faking_it ? SVt_PVCV : sv_type);
2376     return gv;
2377 }
2378
2379 void
2380 Perl_gv_fullname4(pTHX_ SV *sv, const GV *gv, const char *prefix, bool keepmain)
2381 {
2382     const char *name;
2383     const HV * const hv = GvSTASH(gv);
2384
2385     PERL_ARGS_ASSERT_GV_FULLNAME4;
2386
2387     sv_setpv(sv, prefix ? prefix : "");
2388
2389     if (hv && (name = HvNAME(hv))) {
2390       const STRLEN len = HvNAMELEN(hv);
2391       if (keepmain || strnNE(name, "main", len)) {
2392         sv_catpvn_flags(sv,name,len,HvNAMEUTF8(hv)?SV_CATUTF8:SV_CATBYTES);
2393         sv_catpvs(sv,"::");
2394       }
2395     }
2396     else sv_catpvs(sv,"__ANON__::");
2397     sv_catsv(sv,sv_2mortal(newSVhek(GvNAME_HEK(gv))));
2398 }
2399
2400 void
2401 Perl_gv_efullname4(pTHX_ SV *sv, const GV *gv, const char *prefix, bool keepmain)
2402 {
2403     const GV * const egv = GvEGVx(gv);
2404
2405     PERL_ARGS_ASSERT_GV_EFULLNAME4;
2406
2407     gv_fullname4(sv, egv ? egv : gv, prefix, keepmain);
2408 }
2409
2410
2411 /* recursively scan a stash and any nested stashes looking for entries
2412  * that need the "only used once" warning raised
2413  */
2414
2415 void
2416 Perl_gv_check(pTHX_ HV *stash)
2417 {
2418     I32 i;
2419
2420     PERL_ARGS_ASSERT_GV_CHECK;
2421
2422     if (!SvOOK(stash))
2423         return;
2424
2425     assert(HvARRAY(stash));
2426
2427     for (i = 0; i <= (I32) HvMAX(stash); i++) {
2428         const HE *entry;
2429         /* mark stash is being scanned, to avoid recursing */
2430         HvAUX(stash)->xhv_aux_flags |= HvAUXf_SCAN_STASH;
2431         for (entry = HvARRAY(stash)[i]; entry; entry = HeNEXT(entry)) {
2432             GV *gv;
2433             HV *hv;
2434             STRLEN keylen = HeKLEN(entry);
2435             const char * const key = HeKEY(entry);
2436
2437             if (keylen >= 2 && key[keylen-2] == ':'  && key[keylen-1] == ':' &&
2438                 (gv = MUTABLE_GV(HeVAL(entry))) && isGV(gv) && (hv = GvHV(gv)))
2439             {
2440                 if (hv != PL_defstash && hv != stash
2441                     && !(SvOOK(hv)
2442                         && (HvAUX(hv)->xhv_aux_flags & HvAUXf_SCAN_STASH))
2443                 )
2444                      gv_check(hv);              /* nested package */
2445             }
2446             else if ( *HeKEY(entry) != '_'
2447                         && isIDFIRST_lazy_if(HeKEY(entry), HeUTF8(entry)) ) {
2448                 const char *file;
2449                 gv = MUTABLE_GV(HeVAL(entry));
2450                 if (SvTYPE(gv) != SVt_PVGV || GvMULTI(gv))
2451                     continue;
2452                 file = GvFILE(gv);
2453                 CopLINE_set(PL_curcop, GvLINE(gv));
2454 #ifdef USE_ITHREADS
2455                 CopFILE(PL_curcop) = (char *)file;      /* set for warning */
2456 #else
2457                 CopFILEGV(PL_curcop)
2458                     = gv_fetchfile_flags(file, HEK_LEN(GvFILE_HEK(gv)), 0);
2459 #endif
2460                 Perl_warner(aTHX_ packWARN(WARN_ONCE),
2461                         "Name \"%"HEKf"::%"HEKf
2462                         "\" used only once: possible typo",
2463                             HEKfARG(HvNAME_HEK(stash)),
2464                             HEKfARG(GvNAME_HEK(gv)));
2465             }
2466         }
2467         HvAUX(stash)->xhv_aux_flags &= ~HvAUXf_SCAN_STASH;
2468     }
2469 }
2470
2471 GV *
2472 Perl_newGVgen_flags(pTHX_ const char *pack, U32 flags)
2473 {
2474     PERL_ARGS_ASSERT_NEWGVGEN_FLAGS;
2475     assert(!(flags & ~SVf_UTF8));
2476
2477     return gv_fetchpv(Perl_form(aTHX_ "%"UTF8f"::_GEN_%ld",
2478                                 UTF8fARG(flags, strlen(pack), pack),
2479                                 (long)PL_gensym++),
2480                       GV_ADD, SVt_PVGV);
2481 }
2482
2483 /* hopefully this is only called on local symbol table entries */
2484
2485 GP*
2486 Perl_gp_ref(pTHX_ GP *gp)
2487 {
2488     if (!gp)
2489         return NULL;
2490     gp->gp_refcnt++;
2491     if (gp->gp_cv) {
2492         if (gp->gp_cvgen) {
2493             /* If the GP they asked for a reference to contains
2494                a method cache entry, clear it first, so that we
2495                don't infect them with our cached entry */
2496             SvREFCNT_dec_NN(gp->gp_cv);
2497             gp->gp_cv = NULL;
2498             gp->gp_cvgen = 0;
2499         }
2500     }
2501     return gp;
2502 }
2503
2504 void
2505 Perl_gp_free(pTHX_ GV *gv)
2506 {
2507     GP* gp;
2508     int attempts = 100;
2509
2510     if (!gv || !isGV_with_GP(gv) || !(gp = GvGP(gv)))
2511         return;
2512     if (gp->gp_refcnt == 0) {
2513         Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
2514                          "Attempt to free unreferenced glob pointers"
2515                          pTHX__FORMAT pTHX__VALUE);
2516         return;
2517     }
2518     if (gp->gp_refcnt > 1) {
2519        borrowed:
2520         if (gp->gp_egv == gv)
2521             gp->gp_egv = 0;
2522         gp->gp_refcnt--;
2523         GvGP_set(gv, NULL);
2524         return;
2525     }
2526
2527     while (1) {
2528       /* Copy and null out all the glob slots, so destructors do not see
2529          freed SVs. */
2530       HEK * const file_hek = gp->gp_file_hek;
2531       SV  * const sv       = gp->gp_sv;
2532       AV  * const av       = gp->gp_av;
2533       HV  * const hv       = gp->gp_hv;
2534       IO  * const io       = gp->gp_io;
2535       CV  * const cv       = gp->gp_cv;
2536       CV  * const form     = gp->gp_form;
2537
2538       gp->gp_file_hek = NULL;
2539       gp->gp_sv       = NULL;
2540       gp->gp_av       = NULL;
2541       gp->gp_hv       = NULL;
2542       gp->gp_io       = NULL;
2543       gp->gp_cv       = NULL;
2544       gp->gp_form     = NULL;
2545
2546       if (file_hek)
2547         unshare_hek(file_hek);
2548
2549       SvREFCNT_dec(sv);
2550       SvREFCNT_dec(av);
2551       /* FIXME - another reference loop GV -> symtab -> GV ?
2552          Somehow gp->gp_hv can end up pointing at freed garbage.  */
2553       if (hv && SvTYPE(hv) == SVt_PVHV) {
2554         const HEK *hvname_hek = HvNAME_HEK(hv);
2555         if (PL_stashcache && hvname_hek) {
2556            DEBUG_o(Perl_deb(aTHX_
2557                           "gp_free clearing PL_stashcache for '%"HEKf"'\n",
2558                            HEKfARG(hvname_hek)));
2559            (void)hv_deletehek(PL_stashcache, hvname_hek, G_DISCARD);
2560         }
2561         SvREFCNT_dec(hv);
2562       }
2563       if (io && SvREFCNT(io) == 1 && IoIFP(io)
2564              && (IoTYPE(io) == IoTYPE_WRONLY ||
2565                  IoTYPE(io) == IoTYPE_RDWR   ||
2566                  IoTYPE(io) == IoTYPE_APPEND)
2567              && ckWARN_d(WARN_IO)
2568              && IoIFP(io) != PerlIO_stdin()
2569              && IoIFP(io) != PerlIO_stdout()
2570              && IoIFP(io) != PerlIO_stderr()
2571              && !(IoFLAGS(io) & IOf_FAKE_DIRP))
2572         io_close(io, gv, FALSE, TRUE);
2573       SvREFCNT_dec(io);
2574       SvREFCNT_dec(cv);
2575       SvREFCNT_dec(form);
2576
2577       /* Possibly reallocated by a destructor */
2578       gp = GvGP(gv);
2579
2580       if (!gp->gp_file_hek
2581        && !gp->gp_sv
2582        && !gp->gp_av
2583        && !gp->gp_hv
2584        && !gp->gp_io
2585        && !gp->gp_cv
2586        && !gp->gp_form) break;
2587
2588       if (--attempts == 0) {
2589         Perl_die(aTHX_
2590           "panic: gp_free failed to free glob pointer - "
2591           "something is repeatedly re-creating entries"
2592         );
2593       }
2594     }
2595
2596     /* Possibly incremented by a destructor doing glob assignment */
2597     if (gp->gp_refcnt > 1) goto borrowed;
2598     Safefree(gp);
2599     GvGP_set(gv, NULL);
2600 }
2601
2602 int
2603 Perl_magic_freeovrld(pTHX_ SV *sv, MAGIC *mg)
2604 {
2605     AMT * const amtp = (AMT*)mg->mg_ptr;
2606     PERL_UNUSED_ARG(sv);
2607
2608     PERL_ARGS_ASSERT_MAGIC_FREEOVRLD;
2609
2610     if (amtp && AMT_AMAGIC(amtp)) {
2611         int i;
2612         for (i = 1; i < NofAMmeth; i++) {
2613             CV * const cv = amtp->table[i];
2614             if (cv) {
2615                 SvREFCNT_dec_NN(MUTABLE_SV(cv));
2616                 amtp->table[i] = NULL;
2617             }
2618         }
2619     }
2620  return 0;
2621 }
2622
2623 /* Updates and caches the CV's */
2624 /* Returns:
2625  * 1 on success and there is some overload
2626  * 0 if there is no overload
2627  * -1 if some error occurred and it couldn't croak
2628  */
2629
2630 int
2631 Perl_Gv_AMupdate(pTHX_ HV *stash, bool destructing)
2632 {
2633   MAGIC* const mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
2634   AMT amt;
2635   const struct mro_meta* stash_meta = HvMROMETA(stash);
2636   U32 newgen;
2637
2638   PERL_ARGS_ASSERT_GV_AMUPDATE;
2639
2640   newgen = PL_sub_generation + stash_meta->pkg_gen + stash_meta->cache_gen;
2641   if (mg) {
2642       const AMT * const amtp = (AMT*)mg->mg_ptr;
2643       if (amtp->was_ok_sub == newgen) {
2644           return AMT_AMAGIC(amtp) ? 1 : 0;
2645       }
2646       sv_unmagic(MUTABLE_SV(stash), PERL_MAGIC_overload_table);
2647   }
2648
2649   DEBUG_o( Perl_deb(aTHX_ "Recalcing overload magic in package %s\n",HvNAME_get(stash)) );
2650
2651   Zero(&amt,1,AMT);
2652   amt.was_ok_sub = newgen;
2653   amt.fallback = AMGfallNO;
2654   amt.flags = 0;
2655
2656   {
2657     int filled = 0;
2658     int i;
2659     bool deref_seen = 0;
2660
2661
2662     /* Work with "fallback" key, which we assume to be first in PL_AMG_names */
2663
2664     /* Try to find via inheritance. */
2665     GV *gv = gv_fetchmeth_pvn(stash, PL_AMG_names[0], 2, -1, 0);
2666     SV * const sv = gv ? GvSV(gv) : NULL;
2667     CV* cv;
2668
2669     if (!gv)
2670     {
2671       if (!gv_fetchmeth_pvn(stash, "((", 2, -1, 0))
2672         goto no_table;
2673     }
2674 #ifdef PERL_DONT_CREATE_GVSV
2675     else if (!sv) {
2676         NOOP;   /* Equivalent to !SvTRUE and !SvOK  */
2677     }
2678 #endif
2679     else if (SvTRUE(sv))
2680         /* don't need to set overloading here because fallback => 1
2681          * is the default setting for classes without overloading */
2682         amt.fallback=AMGfallYES;
2683     else if (SvOK(sv)) {
2684         amt.fallback=AMGfallNEVER;
2685         filled = 1;
2686     }
2687     else {
2688         filled = 1;
2689     }
2690
2691     assert(SvOOK(stash));
2692     /* initially assume the worst */
2693     HvAUX(stash)->xhv_aux_flags &= ~HvAUXf_NO_DEREF;
2694
2695     for (i = 1; i < NofAMmeth; i++) {
2696         const char * const cooky = PL_AMG_names[i];
2697         /* Human-readable form, for debugging: */
2698         const char * const cp = AMG_id2name(i);
2699         const STRLEN l = PL_AMG_namelens[i];
2700
2701         DEBUG_o( Perl_deb(aTHX_ "Checking overloading of \"%s\" in package \"%.256s\"\n",
2702                      cp, HvNAME_get(stash)) );
2703         /* don't fill the cache while looking up!
2704            Creation of inheritance stubs in intermediate packages may
2705            conflict with the logic of runtime method substitution.
2706            Indeed, for inheritance A -> B -> C, if C overloads "+0",
2707            then we could have created stubs for "(+0" in A and C too.
2708            But if B overloads "bool", we may want to use it for
2709            numifying instead of C's "+0". */
2710         gv = Perl_gv_fetchmeth_pvn(aTHX_ stash, cooky, l, -1, 0);
2711         cv = 0;
2712         if (gv && (cv = GvCV(gv)) && CvHASGV(cv)) {
2713             const HEK * const gvhek =
2714                 CvNAMED(cv) ? CvNAME_HEK(cv) : GvNAME_HEK(CvGV(cv));
2715             const HEK * const stashek =
2716                 HvNAME_HEK(CvNAMED(cv) ? CvSTASH(cv) : GvSTASH(CvGV(cv)));
2717             if (HEK_LEN(gvhek) == 3 && strEQ(HEK_KEY(gvhek), "nil")
2718              && stashek && HEK_LEN(stashek) == 8
2719              && strEQ(HEK_KEY(stashek), "overload")) {
2720                 /* This is a hack to support autoloading..., while
2721                    knowing *which* methods were declared as overloaded. */
2722                 /* GvSV contains the name of the method. */
2723                 GV *ngv = NULL;
2724                 SV *gvsv = GvSV(gv);
2725
2726                 DEBUG_o( Perl_deb(aTHX_ "Resolving method \"%"SVf256\
2727                         "\" for overloaded \"%s\" in package \"%.256s\"\n",
2728                              (void*)GvSV(gv), cp, HvNAME(stash)) );
2729                 if (!gvsv || !SvPOK(gvsv)
2730                     || !(ngv = gv_fetchmethod_sv_flags(stash, gvsv, 0)))
2731                 {
2732                     /* Can be an import stub (created by "can"). */
2733                     if (destructing) {
2734                         return -1;
2735                     }
2736                     else {
2737                         const SV * const name = (gvsv && SvPOK(gvsv))
2738                                                     ? gvsv
2739                                                     : newSVpvs_flags("???", SVs_TEMP);
2740                         /* diag_listed_as: Can't resolve method "%s" overloading "%s" in package "%s" */
2741                         Perl_croak(aTHX_ "%s method \"%"SVf256
2742                                     "\" overloading \"%s\" "\
2743                                     "in package \"%"HEKf256"\"",
2744                                    (GvCVGEN(gv) ? "Stub found while resolving"
2745                                     : "Can't resolve"),
2746                                    SVfARG(name), cp,
2747                                    HEKfARG(
2748                                         HvNAME_HEK(stash)
2749                                    ));
2750                     }
2751                 }
2752                 cv = GvCV(gv = ngv);
2753             }
2754             DEBUG_o( Perl_deb(aTHX_ "Overloading \"%s\" in package \"%.256s\" via \"%.256s::%.256s\"\n",
2755                          cp, HvNAME_get(stash), HvNAME_get(GvSTASH(CvGV(cv))),
2756                          GvNAME(CvGV(cv))) );
2757             filled = 1;
2758         } else if (gv) {                /* Autoloaded... */
2759             cv = MUTABLE_CV(gv);
2760             filled = 1;
2761         }
2762         amt.table[i]=MUTABLE_CV(SvREFCNT_inc_simple(cv));
2763
2764         if (gv) {
2765             switch (i) {
2766             case to_sv_amg:
2767             case to_av_amg:
2768             case to_hv_amg:
2769             case to_gv_amg:
2770             case to_cv_amg:
2771             case nomethod_amg:
2772                 deref_seen = 1;
2773                 break;
2774             }
2775         }
2776     }
2777     if (!deref_seen)
2778         /* none of @{} etc overloaded; we can do $obj->[N] quicker.
2779          * NB - aux var invalid here, HvARRAY() could have been
2780          * reallocated since it was assigned to */
2781         HvAUX(stash)->xhv_aux_flags |= HvAUXf_NO_DEREF;
2782
2783     if (filled) {
2784       AMT_AMAGIC_on(&amt);
2785       sv_magic(MUTABLE_SV(stash), 0, PERL_MAGIC_overload_table,
2786                                                 (char*)&amt, sizeof(AMT));
2787       return TRUE;
2788     }
2789   }
2790   /* Here we have no table: */
2791  no_table:
2792   AMT_AMAGIC_off(&amt);
2793   sv_magic(MUTABLE_SV(stash), 0, PERL_MAGIC_overload_table,
2794                                                 (char*)&amt, sizeof(AMTS));
2795   return 0;
2796 }
2797
2798
2799 CV*
2800 Perl_gv_handler(pTHX_ HV *stash, I32 id)
2801 {
2802     MAGIC *mg;
2803     AMT *amtp;
2804     U32 newgen;
2805     struct mro_meta* stash_meta;
2806
2807     if (!stash || !HvNAME_get(stash))
2808         return NULL;
2809
2810     stash_meta = HvMROMETA(stash);
2811     newgen = PL_sub_generation + stash_meta->pkg_gen + stash_meta->cache_gen;
2812
2813     mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
2814     if (!mg) {
2815       do_update:
2816         if (Gv_AMupdate(stash, 0) == -1)
2817             return NULL;
2818         mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
2819     }
2820     assert(mg);
2821     amtp = (AMT*)mg->mg_ptr;
2822     if ( amtp->was_ok_sub != newgen )
2823         goto do_update;
2824     if (AMT_AMAGIC(amtp)) {
2825         CV * const ret = amtp->table[id];
2826         if (ret && isGV(ret)) {         /* Autoloading stab */
2827             /* Passing it through may have resulted in a warning
2828                "Inherited AUTOLOAD for a non-method deprecated", since
2829                our caller is going through a function call, not a method call.
2830                So return the CV for AUTOLOAD, setting $AUTOLOAD. */
2831             GV * const gv = gv_fetchmethod(stash, PL_AMG_names[id]);
2832
2833             if (gv && GvCV(gv))
2834                 return GvCV(gv);
2835         }
2836         return ret;
2837     }
2838
2839     return NULL;
2840 }
2841
2842
2843 /* Implement tryAMAGICun_MG macro.
2844    Do get magic, then see if the stack arg is overloaded and if so call it.
2845    Flags:
2846         AMGf_set     return the arg using SETs rather than assigning to
2847                      the targ
2848         AMGf_numeric apply sv_2num to the stack arg.
2849 */
2850
2851 bool
2852 Perl_try_amagic_un(pTHX_ int method, int flags) {
2853     dSP;
2854     SV* tmpsv;
2855     SV* const arg = TOPs;
2856
2857     SvGETMAGIC(arg);
2858
2859     if (SvAMAGIC(arg) && (tmpsv = amagic_call(arg, &PL_sv_undef, method,
2860                                               AMGf_noright | AMGf_unary
2861                                             | (flags & AMGf_numarg))))
2862     {
2863         if (flags & AMGf_set) {
2864             SETs(tmpsv);
2865         }
2866         else {
2867             dTARGET;
2868             if (SvPADMY(TARG)) {
2869                 sv_setsv(TARG, tmpsv);
2870                 SETTARG;
2871             }
2872             else
2873                 SETs(tmpsv);
2874         }
2875         PUTBACK;
2876         return TRUE;
2877     }
2878
2879     if ((flags & AMGf_numeric) && SvROK(arg))
2880         *sp = sv_2num(arg);
2881     return FALSE;
2882 }
2883
2884
2885 /* Implement tryAMAGICbin_MG macro.
2886    Do get magic, then see if the two stack args are overloaded and if so
2887    call it.
2888    Flags:
2889         AMGf_set     return the arg using SETs rather than assigning to
2890                      the targ
2891         AMGf_assign  op may be called as mutator (eg +=)
2892         AMGf_numeric apply sv_2num to the stack arg.
2893 */
2894
2895 bool
2896 Perl_try_amagic_bin(pTHX_ int method, int flags) {
2897     dSP;
2898     SV* const left = TOPm1s;
2899     SV* const right = TOPs;
2900
2901     SvGETMAGIC(left);
2902     if (left != right)
2903         SvGETMAGIC(right);
2904
2905     if (SvAMAGIC(left) || SvAMAGIC(right)) {
2906         SV * const tmpsv = amagic_call(left, right, method,
2907                     ((flags & AMGf_assign) && opASSIGN ? AMGf_assign: 0)
2908                   | (flags & AMGf_numarg));
2909         if (tmpsv) {
2910             if (flags & AMGf_set) {
2911                 (void)POPs;
2912                 SETs(tmpsv);
2913             }
2914             else {
2915                 dATARGET;
2916                 (void)POPs;
2917                 if (opASSIGN || SvPADMY(TARG)) {
2918                     sv_setsv(TARG, tmpsv);
2919                     SETTARG;
2920                 }
2921                 else
2922                     SETs(tmpsv);
2923             }
2924             PUTBACK;
2925             return TRUE;
2926         }
2927     }
2928     if(left==right && SvGMAGICAL(left)) {
2929         SV * const left = sv_newmortal();
2930         *(sp-1) = left;
2931         /* Print the uninitialized warning now, so it includes the vari-
2932            able name. */
2933         if (!SvOK(right)) {
2934             if (ckWARN(WARN_UNINITIALIZED)) report_uninit(right);
2935             sv_setsv_flags(left, &PL_sv_no, 0);
2936         }
2937         else sv_setsv_flags(left, right, 0);
2938         SvGETMAGIC(right);
2939     }
2940     if (flags & AMGf_numeric) {
2941         if (SvROK(TOPm1s))
2942             *(sp-1) = sv_2num(TOPm1s);
2943         if (SvROK(right))
2944             *sp     = sv_2num(right);
2945     }
2946     return FALSE;
2947 }
2948
2949 SV *
2950 Perl_amagic_deref_call(pTHX_ SV *ref, int method) {
2951     SV *tmpsv = NULL;
2952     HV *stash;
2953
2954     PERL_ARGS_ASSERT_AMAGIC_DEREF_CALL;
2955
2956     if (!SvAMAGIC(ref))
2957         return ref;
2958     /* return quickly if none of the deref ops are overloaded */
2959     stash = SvSTASH(SvRV(ref));
2960     assert(SvOOK(stash));
2961     if (HvAUX(stash)->xhv_aux_flags & HvAUXf_NO_DEREF)
2962         return ref;
2963
2964     while ((tmpsv = amagic_call(ref, &PL_sv_undef, method,
2965                                 AMGf_noright | AMGf_unary))) { 
2966         if (!SvROK(tmpsv))
2967             Perl_croak(aTHX_ "Overloaded dereference did not return a reference");
2968         if (tmpsv == ref || SvRV(tmpsv) == SvRV(ref)) {
2969             /* Bail out if it returns us the same reference.  */
2970             return tmpsv;
2971         }
2972         ref = tmpsv;
2973         if (!SvAMAGIC(ref))
2974             break;
2975     }
2976     return tmpsv ? tmpsv : ref;
2977 }
2978
2979 bool
2980 Perl_amagic_is_enabled(pTHX_ int method)
2981 {
2982       SV *lex_mask = cop_hints_fetch_pvs(PL_curcop, "overloading", 0);
2983
2984       assert(PL_curcop->cop_hints & HINT_NO_AMAGIC);
2985
2986       if ( !lex_mask || !SvOK(lex_mask) )
2987           /* overloading lexically disabled */
2988           return FALSE;
2989       else if ( lex_mask && SvPOK(lex_mask) ) {
2990           /* we have an entry in the hints hash, check if method has been
2991            * masked by overloading.pm */
2992           STRLEN len;
2993           const int offset = method / 8;
2994           const int bit    = method % 8;
2995           char *pv = SvPV(lex_mask, len);
2996
2997           /* Bit set, so this overloading operator is disabled */
2998           if ( (STRLEN)offset < len && pv[offset] & ( 1 << bit ) )
2999               return FALSE;
3000       }
3001       return TRUE;
3002 }
3003
3004 SV*
3005 Perl_amagic_call(pTHX_ SV *left, SV *right, int method, int flags)
3006 {
3007   dVAR;
3008   MAGIC *mg;
3009   CV *cv=NULL;
3010   CV **cvp=NULL, **ocvp=NULL;
3011   AMT *amtp=NULL, *oamtp=NULL;
3012   int off = 0, off1, lr = 0, notfound = 0;
3013   int postpr = 0, force_cpy = 0;
3014   int assign = AMGf_assign & flags;
3015   const int assignshift = assign ? 1 : 0;
3016   int use_default_op = 0;
3017   int force_scalar = 0;
3018 #ifdef DEBUGGING
3019   int fl=0;
3020 #endif
3021   HV* stash=NULL;
3022
3023   PERL_ARGS_ASSERT_AMAGIC_CALL;
3024
3025   if ( PL_curcop->cop_hints & HINT_NO_AMAGIC ) {
3026       if (!amagic_is_enabled(method)) return NULL;
3027   }
3028
3029   if (!(AMGf_noleft & flags) && SvAMAGIC(left)
3030       && (stash = SvSTASH(SvRV(left))) && Gv_AMG(stash)
3031       && (mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table))
3032       && (ocvp = cvp = (AMT_AMAGIC((AMT*)mg->mg_ptr)
3033                         ? (oamtp = amtp = (AMT*)mg->mg_ptr)->table
3034                         : NULL))
3035       && ((cv = cvp[off=method+assignshift])
3036           || (assign && amtp->fallback > AMGfallNEVER && /* fallback to
3037                                                           * usual method */
3038                   (
3039 #ifdef DEBUGGING
3040                    fl = 1,
3041 #endif
3042                    cv = cvp[off=method])))) {
3043     lr = -1;                    /* Call method for left argument */
3044   } else {
3045     if (cvp && amtp->fallback > AMGfallNEVER && flags & AMGf_unary) {
3046       int logic;
3047
3048       /* look for substituted methods */
3049       /* In all the covered cases we should be called with assign==0. */
3050          switch (method) {
3051          case inc_amg:
3052            force_cpy = 1;
3053            if ((cv = cvp[off=add_ass_amg])
3054                || ((cv = cvp[off = add_amg]) && (force_cpy = 0, postpr = 1))) {
3055              right = &PL_sv_yes; lr = -1; assign = 1;
3056            }
3057            break;
3058          case dec_amg:
3059            force_cpy = 1;
3060            if ((cv = cvp[off = subtr_ass_amg])
3061                || ((cv = cvp[off = subtr_amg]) && (force_cpy = 0, postpr=1))) {
3062              right = &PL_sv_yes; lr = -1; assign = 1;
3063            }
3064            break;
3065          case bool__amg:
3066            (void)((cv = cvp[off=numer_amg]) || (cv = cvp[off=string_amg]));
3067            break;
3068          case numer_amg:
3069            (void)((cv = cvp[off=string_amg]) || (cv = cvp[off=bool__amg]));
3070            break;
3071          case string_amg:
3072            (void)((cv = cvp[off=numer_amg]) || (cv = cvp[off=bool__amg]));
3073            break;
3074          case not_amg:
3075            (void)((cv = cvp[off=bool__amg])
3076                   || (cv = cvp[off=numer_amg])
3077                   || (cv = cvp[off=string_amg]));
3078            if (cv)
3079                postpr = 1;
3080            break;
3081          case copy_amg:
3082            {
3083              /*
3084                   * SV* ref causes confusion with the interpreter variable of
3085                   * the same name
3086                   */
3087              SV* const tmpRef=SvRV(left);
3088              if (!SvROK(tmpRef) && SvTYPE(tmpRef) <= SVt_PVMG) {
3089                 /*
3090                  * Just to be extra cautious.  Maybe in some
3091                  * additional cases sv_setsv is safe, too.
3092                  */
3093                 SV* const newref = newSVsv(tmpRef);
3094                 SvOBJECT_on(newref);
3095                 /* No need to do SvAMAGIC_on here, as SvAMAGIC macros
3096                    delegate to the stash. */
3097                 SvSTASH_set(newref, MUTABLE_HV(SvREFCNT_inc(SvSTASH(tmpRef))));
3098                 return newref;
3099              }
3100            }
3101            break;
3102          case abs_amg:
3103            if ((cvp[off1=lt_amg] || cvp[off1=ncmp_amg])
3104                && ((cv = cvp[off=neg_amg]) || (cv = cvp[off=subtr_amg]))) {
3105              SV* const nullsv=sv_2mortal(newSViv(0));
3106              if (off1==lt_amg) {
3107                SV* const lessp = amagic_call(left,nullsv,
3108                                        lt_amg,AMGf_noright);
3109                logic = SvTRUE(lessp);
3110              } else {
3111                SV* const lessp = amagic_call(left,nullsv,
3112                                        ncmp_amg,AMGf_noright);
3113                logic = (SvNV(lessp) < 0);
3114              }
3115              if (logic) {
3116                if (off==subtr_amg) {
3117                  right = left;
3118                  left = nullsv;
3119                  lr = 1;
3120                }
3121              } else {
3122                return left;
3123              }
3124            }
3125            break;
3126          case neg_amg:
3127            if ((cv = cvp[off=subtr_amg])) {
3128              right = left;
3129              left = sv_2mortal(newSViv(0));
3130              lr = 1;
3131            }
3132            break;
3133          case int_amg:
3134          case iter_amg:                 /* XXXX Eventually should do to_gv. */
3135          case ftest_amg:                /* XXXX Eventually should do to_gv. */
3136          case regexp_amg:
3137              /* FAIL safe */
3138              return NULL;       /* Delegate operation to standard mechanisms. */
3139
3140          case to_sv_amg:
3141          case to_av_amg:
3142          case to_hv_amg:
3143          case to_gv_amg:
3144          case to_cv_amg:
3145              /* FAIL safe */
3146              return left;       /* Delegate operation to standard mechanisms. */
3147
3148          default:
3149            goto not_found;
3150          }
3151          if (!cv) goto not_found;
3152     } else if (!(AMGf_noright & flags) && SvAMAGIC(right)
3153                && (stash = SvSTASH(SvRV(right))) && Gv_AMG(stash)
3154                && (mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table))
3155                && (cvp = (AMT_AMAGIC((AMT*)mg->mg_ptr)
3156                           ? (amtp = (AMT*)mg->mg_ptr)->table
3157                           : NULL))
3158                && (cv = cvp[off=method])) { /* Method for right
3159                                              * argument found */
3160       lr=1;
3161     } else if (((cvp && amtp->fallback > AMGfallNEVER)
3162                 || (ocvp && oamtp->fallback > AMGfallNEVER))
3163                && !(flags & AMGf_unary)) {
3164                                 /* We look for substitution for
3165                                  * comparison operations and
3166                                  * concatenation */
3167       if (method==concat_amg || method==concat_ass_amg
3168           || method==repeat_amg || method==repeat_ass_amg) {
3169         return NULL;            /* Delegate operation to string conversion */
3170       }
3171       off = -1;
3172       switch (method) {
3173          case lt_amg:
3174          case le_amg:
3175          case gt_amg:
3176          case ge_amg:
3177          case eq_amg:
3178          case ne_amg:
3179              off = ncmp_amg;
3180              break;
3181          case slt_amg:
3182          case sle_amg:
3183          case sgt_amg:
3184          case sge_amg:
3185          case seq_amg:
3186          case sne_amg:
3187              off = scmp_amg;
3188              break;
3189          }
3190       if (off != -1) {
3191           if (ocvp && (oamtp->fallback > AMGfallNEVER)) {
3192               cv = ocvp[off];
3193               lr = -1;
3194           }
3195           if (!cv && (cvp && amtp->fallback > AMGfallNEVER)) {
3196               cv = cvp[off];
3197               lr = 1;
3198           }
3199       }
3200       if (cv)
3201           postpr = 1;
3202       else
3203           goto not_found;
3204     } else {
3205     not_found:                  /* No method found, either report or croak */
3206       switch (method) {
3207          case to_sv_amg:
3208          case to_av_amg:
3209          case to_hv_amg:
3210          case to_gv_amg:
3211          case to_cv_amg:
3212              /* FAIL safe */
3213              return left;       /* Delegate operation to standard mechanisms. */
3214       }
3215       if (ocvp && (cv=ocvp[nomethod_amg])) { /* Call report method */
3216         notfound = 1; lr = -1;
3217       } else if (cvp && (cv=cvp[nomethod_amg])) {
3218         notfound = 1; lr = 1;
3219       } else if ((use_default_op =
3220                   (!ocvp || oamtp->fallback >= AMGfallYES)
3221                   && (!cvp || amtp->fallback >= AMGfallYES))
3222                  && !DEBUG_o_TEST) {
3223         /* Skip generating the "no method found" message.  */
3224         return NULL;
3225       } else {
3226         SV *msg;
3227         if (off==-1) off=method;
3228         msg = sv_2mortal(Perl_newSVpvf(aTHX_
3229                       "Operation \"%s\": no method found,%sargument %s%"SVf"%s%"SVf,
3230                       AMG_id2name(method + assignshift),
3231                       (flags & AMGf_unary ? " " : "\n\tleft "),
3232                       SvAMAGIC(left)?
3233                         "in overloaded package ":
3234                         "has no overloaded magic",
3235                       SvAMAGIC(left)?
3236                         SVfARG(sv_2mortal(newSVhek(HvNAME_HEK(SvSTASH(SvRV(left)))))):
3237                         SVfARG(&PL_sv_no),
3238                       SvAMAGIC(right)?
3239                         ",\n\tright argument in overloaded package ":
3240                         (flags & AMGf_unary
3241                          ? ""
3242                          : ",\n\tright argument has no overloaded magic"),
3243                       SvAMAGIC(right)?
3244                         SVfARG(sv_2mortal(newSVhek(HvNAME_HEK(SvSTASH(SvRV(right)))))):
3245                         SVfARG(&PL_sv_no)));
3246         if (use_default_op) {
3247           DEBUG_o( Perl_deb(aTHX_ "%"SVf, SVfARG(msg)) );
3248         } else {
3249           Perl_croak(aTHX_ "%"SVf, SVfARG(msg));
3250         }
3251         return NULL;
3252       }
3253       force_cpy = force_cpy || assign;
3254     }
3255   }
3256
3257   switch (method) {
3258     /* in these cases, we're calling '+' or '-' as a fallback for a ++ or --
3259      * operation. we need this to return a value, so that it can be assigned
3260      * later on, in the postpr block (case inc_amg/dec_amg), even if the
3261      * increment or decrement was itself called in void context */
3262     case inc_amg:
3263       if (off == add_amg)
3264         force_scalar = 1;
3265       break;
3266     case dec_amg:
3267       if (off == subtr_amg)
3268         force_scalar = 1;
3269       break;
3270     /* in these cases, we're calling an assignment variant of an operator
3271      * (+= rather than +, for instance). regardless of whether it's a
3272      * fallback or not, it always has to return a value, which will be
3273      * assigned to the proper variable later */
3274     case add_amg:
3275     case subtr_amg:
3276     case mult_amg:
3277     case div_amg:
3278     case modulo_amg:
3279     case pow_amg:
3280     case lshift_amg:
3281     case rshift_amg:
3282     case repeat_amg:
3283     case concat_amg:
3284     case band_amg:
3285     case bor_amg:
3286     case bxor_amg:
3287     case sband_amg:
3288     case sbor_amg:
3289     case sbxor_amg:
3290       if (assign)
3291         force_scalar = 1;
3292       break;
3293     /* the copy constructor always needs to return a value */
3294     case copy_amg:
3295       force_scalar = 1;
3296       break;
3297     /* because of the way these are implemented (they don't perform the
3298      * dereferencing themselves, they return a reference that perl then
3299      * dereferences later), they always have to be in scalar context */
3300     case to_sv_amg:
3301     case to_av_amg:
3302     case to_hv_amg:
3303     case to_gv_amg:
3304     case to_cv_amg:
3305       force_scalar = 1;
3306       break;
3307     /* these don't have an op of their own; they're triggered by their parent
3308      * op, so the context there isn't meaningful ('$a and foo()' in void
3309      * context still needs to pass scalar context on to $a's bool overload) */
3310     case bool__amg:
3311     case numer_amg:
3312     case string_amg:
3313       force_scalar = 1;
3314       break;
3315   }
3316
3317 #ifdef DEBUGGING
3318   if (!notfound) {
3319     DEBUG_o(Perl_deb(aTHX_
3320                      "Overloaded operator \"%s\"%s%s%s:\n\tmethod%s found%s in package %"SVf"%s\n",
3321                      AMG_id2name(off),
3322                      method+assignshift==off? "" :
3323                      " (initially \"",
3324                      method+assignshift==off? "" :
3325                      AMG_id2name(method+assignshift),
3326                      method+assignshift==off? "" : "\")",
3327                      flags & AMGf_unary? "" :
3328                      lr==1 ? " for right argument": " for left argument",
3329                      flags & AMGf_unary? " for argument" : "",
3330                      stash ? SVfARG(sv_2mortal(newSVhek(HvNAME_HEK(stash)))) : SVfARG(newSVpvs_flags("null", SVs_TEMP)),
3331                      fl? ",\n\tassignment variant used": "") );
3332   }
3333 #endif
3334     /* Since we use shallow copy during assignment, we need
3335      * to dublicate the contents, probably calling user-supplied
3336      * version of copy operator
3337      */
3338     /* We need to copy in following cases:
3339      * a) Assignment form was called.
3340      *          assignshift==1,  assign==T, method + 1 == off
3341      * b) Increment or decrement, called directly.
3342      *          assignshift==0,  assign==0, method + 0 == off
3343      * c) Increment or decrement, translated to assignment add/subtr.
3344      *          assignshift==0,  assign==T,
3345      *          force_cpy == T
3346      * d) Increment or decrement, translated to nomethod.
3347      *          assignshift==0,  assign==0,
3348      *          force_cpy == T
3349      * e) Assignment form translated to nomethod.
3350      *          assignshift==1,  assign==T, method + 1 != off
3351      *          force_cpy == T
3352      */
3353     /*  off is method, method+assignshift, or a result of opcode substitution.
3354      *  In the latter case assignshift==0, so only notfound case is important.
3355      */
3356   if ( (lr == -1) && ( ( (method + assignshift == off)
3357         && (assign || (method == inc_amg) || (method == dec_amg)))
3358       || force_cpy) )
3359   {
3360       /* newSVsv does not behave as advertised, so we copy missing
3361        * information by hand */
3362       SV *tmpRef = SvRV(left);
3363       SV *rv_copy;
3364       if (SvREFCNT(tmpRef) > 1 && (rv_copy = AMG_CALLunary(left,copy_amg))) {
3365           SvRV_set(left, rv_copy);
3366           SvSETMAGIC(left);
3367           SvREFCNT_dec_NN(tmpRef);  
3368       }
3369   }
3370
3371   {
3372     dSP;
3373     BINOP myop;
3374     SV* res;
3375     const bool oldcatch = CATCH_GET;
3376     I32 oldmark, nret;
3377     U8 gimme = force_scalar ? G_SCALAR : GIMME_V;
3378
3379     CATCH_SET(TRUE);
3380     Zero(&myop, 1, BINOP);
3381     myop.op_last = (OP *) &myop;
3382     myop.op_next = NULL;
3383     myop.op_flags = OPf_STACKED;
3384
3385     switch (gimme) {
3386         case G_VOID:
3387             myop.op_flags |= OPf_WANT_VOID;
3388             break;
3389         case G_ARRAY:
3390             if (flags & AMGf_want_list) {
3391                 myop.op_flags |= OPf_WANT_LIST;
3392                 break;
3393             }
3394             /* FALLTHROUGH */
3395         default:
3396             myop.op_flags |= OPf_WANT_SCALAR;
3397             break;
3398     }
3399
3400     PUSHSTACKi(PERLSI_OVERLOAD);
3401     ENTER;
3402     SAVEOP();
3403     PL_op = (OP *) &myop;
3404     if (PERLDB_SUB && PL_curstash != PL_debstash)
3405         PL_op->op_private |= OPpENTERSUB_DB;
3406     Perl_pp_pushmark(aTHX);
3407
3408     EXTEND(SP, notfound + 5);
3409     PUSHs(lr>0? right: left);
3410     PUSHs(lr>0? left: right);
3411     PUSHs( lr > 0 ? &PL_sv_yes : ( assign ? &PL_sv_undef : &PL_sv_no ));
3412     if (notfound) {
3413       PUSHs(newSVpvn_flags(AMG_id2name(method + assignshift),
3414                            AMG_id2namelen(method + assignshift), SVs_TEMP));
3415     }
3416     else if (flags & AMGf_numarg)
3417       PUSHs(&PL_sv_undef);
3418     if (flags & AMGf_numarg)
3419       PUSHs(&PL_sv_yes);
3420     PUSHs(MUTABLE_SV(cv));
3421     PUTBACK;
3422     oldmark = TOPMARK;
3423
3424     if ((PL_op = PL_ppaddr[OP_ENTERSUB](aTHX)))
3425       CALLRUNOPS(aTHX);
3426     LEAVE;
3427     SPAGAIN;
3428     nret = SP - (PL_stack_base + oldmark);
3429
3430     switch (gimme) {
3431         case G_VOID:
3432             /* returning NULL has another meaning, and we check the context
3433              * at the call site too, so this can be differentiated from the
3434              * scalar case */
3435             res = &PL_sv_undef;
3436             SP = PL_stack_base + oldmark;
3437             break;
3438         case G_ARRAY: {
3439             if (flags & AMGf_want_list) {
3440                 res = sv_2mortal((SV *)newAV());
3441                 av_extend((AV *)res, nret);
3442                 while (nret--)
3443                     av_store((AV *)res, nret, POPs);
3444                 break;
3445             }
3446             /* FALLTHROUGH */
3447         }
3448         default:
3449             res = POPs;
3450             break;
3451     }
3452
3453     PUTBACK;
3454     POPSTACK;
3455     CATCH_SET(oldcatch);
3456
3457     if (postpr) {
3458       int ans;
3459       switch (method) {
3460       case le_amg:
3461       case sle_amg:
3462         ans=SvIV(res)<=0; break;
3463       case lt_amg:
3464       case slt_amg:
3465         ans=SvIV(res)<0; break;
3466       case ge_amg:
3467       case sge_amg:
3468         ans=SvIV(res)>=0; break;
3469       case gt_amg:
3470       case sgt_amg:
3471         ans=SvIV(res)>0; break;
3472       case eq_amg:
3473       case seq_amg:
3474         ans=SvIV(res)==0; break;
3475       case ne_amg:
3476       case sne_amg:
3477         ans=SvIV(res)!=0; break;
3478       case inc_amg:
3479       case dec_amg:
3480         SvSetSV(left,res); return left;
3481       case not_amg:
3482         ans=!SvTRUE(res); break;
3483       default:
3484         ans=0; break;
3485       }
3486       return boolSV(ans);
3487     } else if (method==copy_amg) {
3488       if (!SvROK(res)) {
3489         Perl_croak(aTHX_ "Copy method did not return a reference");
3490       }
3491       return SvREFCNT_inc(SvRV(res));
3492     } else {
3493       return res;
3494     }
3495   }
3496 }
3497
3498 void
3499 Perl_gv_name_set(pTHX_ GV *gv, const char *name, U32 len, U32 flags)
3500 {
3501     dVAR;
3502     U32 hash;
3503
3504     PERL_ARGS_ASSERT_GV_NAME_SET;
3505
3506     if (len > I32_MAX)
3507         Perl_croak(aTHX_ "panic: gv name too long (%"UVuf")", (UV) len);
3508
3509     if (!(flags & GV_ADD) && GvNAME_HEK(gv)) {
3510         unshare_hek(GvNAME_HEK(gv));
3511     }
3512
3513     PERL_HASH(hash, name, len);
3514     GvNAME_HEK(gv) = share_hek(name, (flags & SVf_UTF8 ? -(I32)len : (I32)len), hash);
3515 }
3516
3517 /*
3518 =for apidoc gv_try_downgrade
3519
3520 If the typeglob C<gv> can be expressed more succinctly, by having
3521 something other than a real GV in its place in the stash, replace it
3522 with the optimised form.  Basic requirements for this are that C<gv>
3523 is a real typeglob, is sufficiently ordinary, and is only referenced
3524 from its package.  This function is meant to be used when a GV has been
3525 looked up in part to see what was there, causing upgrading, but based
3526 on what was found it turns out that the real GV isn't required after all.
3527
3528 If C<gv> is a completely empty typeglob, it is deleted from the stash.
3529
3530 If C<gv> is a typeglob containing only a sufficiently-ordinary constant
3531 sub, the typeglob is replaced with a scalar-reference placeholder that
3532 more compactly represents the same thing.
3533
3534 =cut
3535 */
3536
3537 void
3538 Perl_gv_try_downgrade(pTHX_ GV *gv)
3539 {
3540     HV *stash;
3541     CV *cv;
3542     HEK *namehek;
3543     SV **gvp;
3544     PERL_ARGS_ASSERT_GV_TRY_DOWNGRADE;
3545
3546     /* XXX Why and where does this leave dangling pointers during global
3547        destruction? */
3548     if (PL_phase == PERL_PHASE_DESTRUCT) return;
3549
3550     if (!(SvREFCNT(gv) == 1 && SvTYPE(gv) == SVt_PVGV && !SvFAKE(gv) &&
3551             !SvOBJECT(gv) && !SvREADONLY(gv) &&
3552             isGV_with_GP(gv) && GvGP(gv) &&
3553             !GvINTRO(gv) && GvREFCNT(gv) == 1 &&
3554             !GvSV(gv) && !GvAV(gv) && !GvHV(gv) && !GvIOp(gv) && !GvFORM(gv) &&
3555             GvEGVx(gv) == gv && (stash = GvSTASH(gv))))
3556         return;
3557     if (gv == PL_statgv || gv == PL_last_in_gv || gv == PL_stderrgv)
3558         return;
3559     if (SvMAGICAL(gv)) {
3560         MAGIC *mg;
3561         /* only backref magic is allowed */
3562         if (SvGMAGICAL(gv) || SvSMAGICAL(gv))
3563             return;
3564         for (mg = SvMAGIC(gv); mg; mg = mg->mg_moremagic) {
3565             if (mg->mg_type != PERL_MAGIC_backref)
3566                 return;
3567         }
3568     }
3569     cv = GvCV(gv);
3570     if (!cv) {
3571         HEK *gvnhek = GvNAME_HEK(gv);
3572         (void)hv_deletehek(stash, gvnhek, G_DISCARD);
3573     } else if (GvMULTI(gv) && cv && SvREFCNT(cv) == 1 &&
3574             !SvOBJECT(cv) && !SvMAGICAL(cv) && !SvREADONLY(cv) &&
3575             CvSTASH(cv) == stash && !CvNAMED(cv) && CvGV(cv) == gv &&
3576             CvCONST(cv) && !CvMETHOD(cv) && !CvLVALUE(cv) && !CvUNIQUE(cv) &&
3577             !CvNODEBUG(cv) && !CvCLONE(cv) && !CvCLONED(cv) && !CvANON(cv) &&
3578             (namehek = GvNAME_HEK(gv)) &&
3579             (gvp = hv_fetchhek(stash, namehek, 0)) &&
3580             *gvp == (SV*)gv) {
3581         SV *value = SvREFCNT_inc(CvXSUBANY(cv).any_ptr);
3582         const bool imported = !!GvIMPORTED_CV(gv);
3583         SvREFCNT(gv) = 0;
3584         sv_clear((SV*)gv);
3585         SvREFCNT(gv) = 1;
3586         SvFLAGS(gv) = SVt_IV|SVf_ROK|SVprv_PCS_IMPORTED * imported;
3587
3588         /* See also: 'SET_SVANY_FOR_BODYLESS_IV' in sv.c */
3589         SvANY(gv) = (XPVGV*)((char*)&(gv->sv_u.svu_iv) -
3590                                 STRUCT_OFFSET(XPVIV, xiv_iv));
3591         SvRV_set(gv, value);
3592     }
3593 }
3594
3595 GV *
3596 Perl_gv_override(pTHX_ const char * const name, const STRLEN len)
3597 {
3598     GV *gv = gv_fetchpvn(name, len, GV_NOTQUAL, SVt_PVCV);
3599     GV * const *gvp;
3600     PERL_ARGS_ASSERT_GV_OVERRIDE;
3601     if (gv && GvCVu(gv) && GvIMPORTED_CV(gv)) return gv;
3602     gvp = (GV**)hv_fetch(PL_globalstash, name, len, FALSE);
3603     gv = gvp ? *gvp : NULL;
3604     if (gv && !isGV(gv)) {
3605         if (!SvPCS_IMPORTED(gv)) return NULL;
3606         gv_init(gv, PL_globalstash, name, len, 0);
3607         return gv;
3608     }
3609     return gv && GvCVu(gv) && GvIMPORTED_CV(gv) ? gv : NULL;
3610 }
3611
3612 #include "XSUB.h"
3613
3614 static void
3615 core_xsub(pTHX_ CV* cv)
3616 {
3617     Perl_croak(aTHX_
3618        "&CORE::%s cannot be called directly", GvNAME(CvGV(cv))
3619     );
3620 }
3621
3622 /*
3623  * ex: set ts=8 sts=4 sw=4 et:
3624  */