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