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