3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
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.
12 * Sam sat on the ground and put his head in his hands. 'I wish I had never
13 * come here, and I don't want to see no more magic,' he said, and fell silent.
15 * [p.363 of _The Lord of the Rings_, II/vii: "The Mirror of Galadriel"]
19 =head1 Magical Functions
20 "Magic" is special data attached to SV structures in order to give them
21 "magical" properties. When any Perl code tries to read from, or assign to,
22 an SV marked as magical, it calls the 'get' or 'set' function associated
23 with that SV's magic. A get is called prior to reading an SV, in order to
24 give it a chance to update its internal value (get on $. writes the line
25 number of the last read filehandle into the SV's IV slot), while
26 set is called after an SV has been written to, in order to allow it to make
27 use of its changed value (set on $/ copies the SV's new value to the
28 PL_rs global variable).
30 Magic is implemented as a linked list of MAGIC structures attached to the
31 SV. Each MAGIC struct holds the type of the magic, a pointer to an array
32 of functions that implement the get(), set(), length() etc functions,
33 plus space for some flags and pointers. For example, a tied variable has
34 a MAGIC structure that contains a pointer to the object associated with the
45 #if defined(HAS_GETGROUPS) || defined(HAS_SETGROUPS)
51 #if defined(HAS_SETGROUPS)
58 # include <sys/pstat.h>
61 #ifdef HAS_PRCTL_SET_NAME
62 # include <sys/prctl.h>
65 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
66 Signal_t Perl_csighandler(int sig, siginfo_t *, void *);
68 Signal_t Perl_csighandler(int sig);
72 /* Missing protos on LynxOS */
73 void setruid(uid_t id);
74 void seteuid(uid_t id);
75 void setrgid(uid_t id);
76 void setegid(uid_t id);
80 * Pre-magic setup and post-magic takedown.
81 * Use the "DESTRUCTOR" scope cleanup to reinstate magic.
90 /* MGS is typedef'ed to struct magic_state in perl.h */
93 S_save_magic_flags(pTHX_ I32 mgs_ix, SV *sv, U32 flags)
98 PERL_ARGS_ASSERT_SAVE_MAGIC_FLAGS;
100 assert(SvMAGICAL(sv));
102 /* we shouldn't really be called here with RC==0, but it can sometimes
103 * happen via mg_clear() (which also shouldn't be called when RC==0,
104 * but it can happen). Handle this case gracefully(ish) by not RC++
105 * and thus avoiding the resultant double free */
106 if (SvREFCNT(sv) > 0) {
107 /* guard against sv getting freed midway through the mg clearing,
108 * by holding a private reference for the duration. */
109 SvREFCNT_inc_simple_void_NN(sv);
113 SAVEDESTRUCTOR_X(S_restore_magic, INT2PTR(void*, (IV)mgs_ix));
115 mgs = SSPTR(mgs_ix, MGS*);
117 mgs->mgs_flags = SvMAGICAL(sv) | SvREADONLY(sv);
118 mgs->mgs_ss_ix = PL_savestack_ix; /* points after the saved destructor */
119 mgs->mgs_bumped = bumped;
121 SvFLAGS(sv) &= ~flags;
125 #define save_magic(a,b) save_magic_flags(a,b,SVs_GMG|SVs_SMG|SVs_RMG)
128 =for apidoc mg_magical
130 Turns on the magical status of an SV. See C<sv_magic>.
136 Perl_mg_magical(SV *sv)
139 PERL_ARGS_ASSERT_MG_MAGICAL;
142 if ((mg = SvMAGIC(sv))) {
144 const MGVTBL* const vtbl = mg->mg_virtual;
146 if (vtbl->svt_get && !(mg->mg_flags & MGf_GSKIP))
153 } while ((mg = mg->mg_moremagic));
154 if (!(SvFLAGS(sv) & (SVs_GMG|SVs_SMG)))
162 Do magic before a value is retrieved from the SV. The type of SV must
163 be >= SVt_PVMG. See C<sv_magic>.
169 Perl_mg_get(pTHX_ SV *sv)
171 const I32 mgs_ix = SSNEW(sizeof(MGS));
174 MAGIC *newmg, *head, *cur, *mg;
176 PERL_ARGS_ASSERT_MG_GET;
178 if (PL_localizing == 1 && sv == DEFSV) return 0;
180 /* We must call svt_get(sv, mg) for each valid entry in the linked
181 list of magic. svt_get() may delete the current entry, add new
182 magic to the head of the list, or upgrade the SV. AMS 20010810 */
184 newmg = cur = head = mg = SvMAGIC(sv);
186 const MGVTBL * const vtbl = mg->mg_virtual;
187 MAGIC * const nextmg = mg->mg_moremagic; /* it may delete itself */
189 if (!(mg->mg_flags & MGf_GSKIP) && vtbl && vtbl->svt_get) {
191 /* taint's mg get is so dumb it doesn't need flag saving */
192 if (!saved && mg->mg_type != PERL_MAGIC_taint) {
193 save_magic(mgs_ix, sv);
197 vtbl->svt_get(aTHX_ sv, mg);
199 /* guard against magic having been deleted - eg FETCH calling
202 /* recalculate flags */
203 (SSPTR(mgs_ix, MGS *))->mgs_flags &= ~(SVs_GMG|SVs_SMG|SVs_RMG);
207 /* recalculate flags if this entry was deleted. */
208 if (mg->mg_flags & MGf_GSKIP)
209 (SSPTR(mgs_ix, MGS *))->mgs_flags &=
210 ~(SVs_GMG|SVs_SMG|SVs_RMG);
212 else if (vtbl == &PL_vtbl_utf8) {
213 /* get-magic can reallocate the PV */
214 magic_setutf8(sv, mg);
220 /* Have we finished with the new entries we saw? Start again
221 where we left off (unless there are more new entries). */
229 /* Were any new entries added? */
230 if (!have_new && (newmg = SvMAGIC(sv)) != head) {
234 /* recalculate flags */
235 (SSPTR(mgs_ix, MGS *))->mgs_flags &= ~(SVs_GMG|SVs_SMG|SVs_RMG);
240 restore_magic(INT2PTR(void *, (IV)mgs_ix));
248 Do magic after a value is assigned to the SV. See C<sv_magic>.
254 Perl_mg_set(pTHX_ SV *sv)
256 const I32 mgs_ix = SSNEW(sizeof(MGS));
260 PERL_ARGS_ASSERT_MG_SET;
262 if (PL_localizing == 2 && sv == DEFSV) return 0;
264 save_magic_flags(mgs_ix, sv, SVs_GMG|SVs_SMG); /* leave SVs_RMG on */
266 for (mg = SvMAGIC(sv); mg; mg = nextmg) {
267 const MGVTBL* vtbl = mg->mg_virtual;
268 nextmg = mg->mg_moremagic; /* it may delete itself */
269 if (mg->mg_flags & MGf_GSKIP) {
270 mg->mg_flags &= ~MGf_GSKIP; /* setting requires another read */
271 (SSPTR(mgs_ix, MGS*))->mgs_flags &= ~(SVs_GMG|SVs_SMG|SVs_RMG);
273 if (PL_localizing == 2
274 && PERL_MAGIC_TYPE_IS_VALUE_MAGIC(mg->mg_type))
276 if (vtbl && vtbl->svt_set)
277 vtbl->svt_set(aTHX_ sv, mg);
280 restore_magic(INT2PTR(void*, (IV)mgs_ix));
285 =for apidoc mg_length
287 Reports on the SV's length in bytes, calling length magic if available,
288 but does not set the UTF8 flag on the sv. It will fall back to 'get'
289 magic if there is no 'length' magic, but with no indication as to
290 whether it called 'get' magic. It assumes the sv is a PVMG or
291 higher. Use sv_len() instead.
297 Perl_mg_length(pTHX_ SV *sv)
302 PERL_ARGS_ASSERT_MG_LENGTH;
304 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
305 const MGVTBL * const vtbl = mg->mg_virtual;
306 if (vtbl && vtbl->svt_len) {
307 const I32 mgs_ix = SSNEW(sizeof(MGS));
308 save_magic(mgs_ix, sv);
309 /* omit MGf_GSKIP -- not changed here */
310 len = vtbl->svt_len(aTHX_ sv, mg);
311 restore_magic(INT2PTR(void*, (IV)mgs_ix));
316 (void)SvPV_const(sv, len);
321 Perl_mg_size(pTHX_ SV *sv)
325 PERL_ARGS_ASSERT_MG_SIZE;
327 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
328 const MGVTBL* const vtbl = mg->mg_virtual;
329 if (vtbl && vtbl->svt_len) {
330 const I32 mgs_ix = SSNEW(sizeof(MGS));
332 save_magic(mgs_ix, sv);
333 /* omit MGf_GSKIP -- not changed here */
334 len = vtbl->svt_len(aTHX_ sv, mg);
335 restore_magic(INT2PTR(void*, (IV)mgs_ix));
342 return AvFILLp((const AV *) sv); /* Fallback to non-tied array */
346 Perl_croak(aTHX_ "Size magic not implemented");
349 NOT_REACHED; /* NOTREACHED */
355 Clear something magical that the SV represents. See C<sv_magic>.
361 Perl_mg_clear(pTHX_ SV *sv)
363 const I32 mgs_ix = SSNEW(sizeof(MGS));
367 PERL_ARGS_ASSERT_MG_CLEAR;
369 save_magic(mgs_ix, sv);
371 for (mg = SvMAGIC(sv); mg; mg = nextmg) {
372 const MGVTBL* const vtbl = mg->mg_virtual;
373 /* omit GSKIP -- never set here */
375 nextmg = mg->mg_moremagic; /* it may delete itself */
377 if (vtbl && vtbl->svt_clear)
378 vtbl->svt_clear(aTHX_ sv, mg);
381 restore_magic(INT2PTR(void*, (IV)mgs_ix));
386 S_mg_findext_flags(const SV *sv, int type, const MGVTBL *vtbl, U32 flags)
393 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
394 if (mg->mg_type == type && (!flags || mg->mg_virtual == vtbl)) {
406 Finds the magic pointer for type matching the SV. See C<sv_magic>.
412 Perl_mg_find(const SV *sv, int type)
414 return S_mg_findext_flags(sv, type, NULL, 0);
418 =for apidoc mg_findext
420 Finds the magic pointer of C<type> with the given C<vtbl> for the C<SV>. See
427 Perl_mg_findext(const SV *sv, int type, const MGVTBL *vtbl)
429 return S_mg_findext_flags(sv, type, vtbl, 1);
433 Perl_mg_find_mglob(pTHX_ SV *sv)
435 PERL_ARGS_ASSERT_MG_FIND_MGLOB;
436 if (SvTYPE(sv) == SVt_PVLV && LvTYPE(sv) == 'y') {
437 /* This sv is only a delegate. //g magic must be attached to
442 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv))
443 return S_mg_findext_flags(sv, PERL_MAGIC_regex_global, 0, 0);
450 Copies the magic from one SV to another. See C<sv_magic>.
456 Perl_mg_copy(pTHX_ SV *sv, SV *nsv, const char *key, I32 klen)
461 PERL_ARGS_ASSERT_MG_COPY;
463 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
464 const MGVTBL* const vtbl = mg->mg_virtual;
465 if ((mg->mg_flags & MGf_COPY) && vtbl->svt_copy){
466 count += vtbl->svt_copy(aTHX_ sv, mg, nsv, key, klen);
469 const char type = mg->mg_type;
470 if (isUPPER(type) && type != PERL_MAGIC_uvar) {
472 (type == PERL_MAGIC_tied)
474 : (type == PERL_MAGIC_regdata && mg->mg_obj)
477 toLOWER(type), key, klen);
486 =for apidoc mg_localize
488 Copy some of the magic from an existing SV to new localized version of that
489 SV. Container magic (eg %ENV, $1, tie)
490 gets copied, value magic doesn't (eg
493 If setmagic is false then no set magic will be called on the new (empty) SV.
494 This typically means that assignment will soon follow (e.g. 'local $x = $y'),
495 and that will handle the magic.
501 Perl_mg_localize(pTHX_ SV *sv, SV *nsv, bool setmagic)
505 PERL_ARGS_ASSERT_MG_LOCALIZE;
510 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
511 const MGVTBL* const vtbl = mg->mg_virtual;
512 if (PERL_MAGIC_TYPE_IS_VALUE_MAGIC(mg->mg_type))
515 if ((mg->mg_flags & MGf_LOCAL) && vtbl->svt_local)
516 (void)vtbl->svt_local(aTHX_ nsv, mg);
518 sv_magicext(nsv, mg->mg_obj, mg->mg_type, vtbl,
519 mg->mg_ptr, mg->mg_len);
521 /* container types should remain read-only across localization */
522 SvFLAGS(nsv) |= SvREADONLY(sv);
525 if (SvTYPE(nsv) >= SVt_PVMG && SvMAGIC(nsv)) {
526 SvFLAGS(nsv) |= SvMAGICAL(sv);
535 #define mg_free_struct(sv, mg) S_mg_free_struct(aTHX_ sv, mg)
537 S_mg_free_struct(pTHX_ SV *sv, MAGIC *mg)
539 const MGVTBL* const vtbl = mg->mg_virtual;
540 if (vtbl && vtbl->svt_free)
541 vtbl->svt_free(aTHX_ sv, mg);
542 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
543 if (mg->mg_len > 0 || mg->mg_type == PERL_MAGIC_utf8)
544 Safefree(mg->mg_ptr);
545 else if (mg->mg_len == HEf_SVKEY)
546 SvREFCNT_dec(MUTABLE_SV(mg->mg_ptr));
548 if (mg->mg_flags & MGf_REFCOUNTED)
549 SvREFCNT_dec(mg->mg_obj);
556 Free any magic storage used by the SV. See C<sv_magic>.
562 Perl_mg_free(pTHX_ SV *sv)
567 PERL_ARGS_ASSERT_MG_FREE;
569 for (mg = SvMAGIC(sv); mg; mg = moremagic) {
570 moremagic = mg->mg_moremagic;
571 mg_free_struct(sv, mg);
572 SvMAGIC_set(sv, moremagic);
574 SvMAGIC_set(sv, NULL);
580 =for apidoc Am|void|mg_free_type|SV *sv|int how
582 Remove any magic of type I<how> from the SV I<sv>. See L</sv_magic>.
588 Perl_mg_free_type(pTHX_ SV *sv, int how)
590 MAGIC *mg, *prevmg, *moremg;
591 PERL_ARGS_ASSERT_MG_FREE_TYPE;
592 for (prevmg = NULL, mg = SvMAGIC(sv); mg; prevmg = mg, mg = moremg) {
594 moremg = mg->mg_moremagic;
595 if (mg->mg_type == how) {
596 /* temporarily move to the head of the magic chain, in case
597 custom free code relies on this historical aspect of mg_free */
599 prevmg->mg_moremagic = moremg;
600 mg->mg_moremagic = SvMAGIC(sv);
603 newhead = mg->mg_moremagic;
604 mg_free_struct(sv, mg);
605 SvMAGIC_set(sv, newhead);
615 Perl_magic_regdata_cnt(pTHX_ SV *sv, MAGIC *mg)
619 PERL_ARGS_ASSERT_MAGIC_REGDATA_CNT;
622 const REGEXP * const rx = PM_GETRE(PL_curpm);
624 if (mg->mg_obj) { /* @+ */
625 /* return the number possible */
626 return RX_NPARENS(rx);
628 I32 paren = RX_LASTPAREN(rx);
630 /* return the last filled */
632 && (RX_OFFS(rx)[paren].start == -1
633 || RX_OFFS(rx)[paren].end == -1) )
646 Perl_magic_regdatum_get(pTHX_ SV *sv, MAGIC *mg)
648 PERL_ARGS_ASSERT_MAGIC_REGDATUM_GET;
651 const REGEXP * const rx = PM_GETRE(PL_curpm);
653 const I32 paren = mg->mg_len;
658 if (paren <= (I32)RX_NPARENS(rx) &&
659 (s = RX_OFFS(rx)[paren].start) != -1 &&
660 (t = RX_OFFS(rx)[paren].end) != -1)
663 if (mg->mg_obj) /* @+ */
668 if (RX_MATCH_UTF8(rx)) {
669 const char * const b = RX_SUBBEG(rx);
671 i = RX_SUBCOFFSET(rx) +
673 (U8*)(b-RX_SUBOFFSET(rx)+i));
688 Perl_magic_regdatum_set(pTHX_ SV *sv, MAGIC *mg)
690 PERL_ARGS_ASSERT_MAGIC_REGDATUM_SET;
694 Perl_croak_no_modify();
695 NORETURN_FUNCTION_END;
698 #define SvRTRIM(sv) STMT_START { \
700 STRLEN len = SvCUR(sv); \
701 char * const p = SvPVX(sv); \
702 while (len > 0 && isSPACE(p[len-1])) \
704 SvCUR_set(sv, len); \
710 Perl_emulate_cop_io(pTHX_ const COP *const c, SV *const sv)
712 PERL_ARGS_ASSERT_EMULATE_COP_IO;
714 if (!(CopHINTS_get(c) & (HINT_LEXICAL_IO_IN|HINT_LEXICAL_IO_OUT)))
715 sv_setsv(sv, &PL_sv_undef);
719 if ((CopHINTS_get(c) & HINT_LEXICAL_IO_IN)) {
720 SV *const value = cop_hints_fetch_pvs(c, "open<", 0);
725 if ((CopHINTS_get(c) & HINT_LEXICAL_IO_OUT)) {
726 SV *const value = cop_hints_fetch_pvs(c, "open>", 0);
734 S_fixup_errno_string(pTHX_ SV* sv)
736 /* Do what is necessary to fixup the non-empty string in 'sv' for return to
739 PERL_ARGS_ASSERT_FIXUP_ERRNO_STRING;
743 if(strEQ(SvPVX(sv), "")) {
744 sv_catpv(sv, UNKNOWN_ERRNO_MSG);
748 /* In some locales the error string may come back as UTF-8, in which
749 * case we should turn on that flag. This didn't use to happen, and to
750 * avoid as many possible backward compatibility issues as possible, we
751 * don't turn on the flag unless we have to. So the flag stays off for
752 * an entirely invariant string. We assume that if the string looks
753 * like UTF-8, it really is UTF-8: "text in any other encoding that
754 * uses bytes with the high bit set is extremely unlikely to pass a
755 * UTF-8 validity test"
756 * (http://en.wikipedia.org/wiki/Charset_detection). There is a
757 * potential that we will get it wrong however, especially on short
758 * error message text. (If it turns out to be necessary, we could also
759 * keep track if the current LC_MESSAGES locale is UTF-8) */
760 if (! IN_BYTES /* respect 'use bytes' */
761 && ! is_invariant_string((U8*) SvPVX_const(sv), SvCUR(sv))
762 && is_utf8_string((U8*) SvPVX_const(sv), SvCUR(sv)))
770 Perl__get_encoding(pTHX)
772 /* For core Perl use only: Returns the $^ENCODING or 'use encoding' in
773 * effect; NULL if none.
775 * $^ENCODING maps to PL_encoding, and is the old way to do things, and is
776 * retained for backwards compatibility. Now, there is a shadow variable
777 * ${^E_NCODING} set only by the encoding pragma, used to give this pragma
778 * lexical scope, unlike the global scope it (shudder) used to have. This
779 * variable maps to PL_lex_encoding. Again for backwards compatibility,
780 * PL_encoding has precedence over PL_lex_encoding. The hints hash is used
781 * to determine if PL_lex_encoding is in scope, and hence valid. The hints
782 * hash only accepts simple values, so we can't put an Encode object into
783 * it, so we put the object into the global, and put a simple boolean into
784 * the hints hash giving whether the global is valid or not */
793 if (! PL_lex_encoding) {
797 is_encoding = cop_hints_fetch_pvs(PL_curcop, "encoding", 0);
799 && is_encoding != &PL_sv_placeholder
800 && SvIOK(is_encoding)
801 && SvIV(is_encoding)) /* non-zero mean valid */
803 return PL_lex_encoding;
815 Perl_magic_get(pTHX_ SV *sv, MAGIC *mg)
818 const char *s = NULL;
820 const char * const remaining = mg->mg_ptr + 1;
823 PERL_ARGS_ASSERT_MAGIC_GET;
827 if (PL_curpm && (rx = PM_GETRE(PL_curpm))) {
829 CALLREG_NUMBUF_FETCH(rx,paren,sv);
831 sv_setsv(sv,&PL_sv_undef);
836 nextchar = *remaining;
837 switch (*mg->mg_ptr) {
838 case '\001': /* ^A */
839 if (SvOK(PL_bodytarget)) sv_copypv(sv, PL_bodytarget);
840 else sv_setsv(sv, &PL_sv_undef);
841 if (SvTAINTED(PL_bodytarget))
844 case '\003': /* ^C, ^CHILD_ERROR_NATIVE */
845 if (nextchar == '\0') {
846 sv_setiv(sv, (IV)PL_minus_c);
848 else if (strEQ(remaining, "HILD_ERROR_NATIVE")) {
849 sv_setiv(sv, (IV)STATUS_NATIVE);
853 case '\004': /* ^D */
854 sv_setiv(sv, (IV)(PL_debug & DEBUG_MASK));
856 case '\005': /* ^E */
857 if (nextchar != '\0') {
858 if (strEQ(remaining, "NCODING"))
859 sv_setsv(sv, _get_encoding());
860 else if (strEQ(remaining, "_NCODING"))
865 #if defined(VMS) || defined(OS2) || defined(WIN32)
869 $DESCRIPTOR(msgdsc,msg);
870 sv_setnv(sv,(NV) vaxc$errno);
871 if (sys$getmsg(vaxc$errno,&msgdsc.dsc$w_length,&msgdsc,0,0) & 1)
872 sv_setpvn(sv,msgdsc.dsc$a_pointer,msgdsc.dsc$w_length);
877 if (!(_emx_env & 0x200)) { /* Under DOS */
878 sv_setnv(sv, (NV)errno);
879 sv_setpv(sv, errno ? my_strerror(errno) : "");
881 if (errno != errno_isOS2) {
882 const int tmp = _syserrno();
883 if (tmp) /* 2nd call to _syserrno() makes it 0 */
886 sv_setnv(sv, (NV)Perl_rc);
887 sv_setpv(sv, os2error(Perl_rc));
889 if (SvOK(sv) && strNE(SvPVX(sv), "")) {
890 fixup_errno_string(sv);
892 # elif defined(WIN32)
894 const DWORD dwErr = GetLastError();
895 sv_setnv(sv, (NV)dwErr);
897 PerlProc_GetOSError(sv, dwErr);
898 fixup_errno_string(sv);
905 # error Missing code for platform
908 SvNOK_on(sv); /* what a wonderful hack! */
910 #endif /* End of platforms with special handling for $^E; others just fall
917 sv_setnv(sv, (NV)((errno == EVMSERR) ? vaxc$errno : errno));
919 sv_setnv(sv, (NV)errno);
922 if (errno == errno_isOS2 || errno == errno_isOS2_set)
923 sv_setpv(sv, os2error(Perl_rc));
931 /* Strerror can return NULL on some platforms, which will
932 * result in 'sv' not being considered SvOK. The SvNOK_on()
933 * below will cause just the number part to be valid */
934 sv_setpv(sv, my_strerror(errno));
936 fixup_errno_string(sv);
943 SvNOK_on(sv); /* what a wonderful hack! */
946 case '\006': /* ^F */
947 sv_setiv(sv, (IV)PL_maxsysfd);
949 case '\007': /* ^GLOBAL_PHASE */
950 if (strEQ(remaining, "LOBAL_PHASE")) {
951 sv_setpvn(sv, PL_phase_names[PL_phase],
952 strlen(PL_phase_names[PL_phase]));
955 case '\010': /* ^H */
956 sv_setiv(sv, (IV)PL_hints);
958 case '\011': /* ^I */ /* NOT \t in EBCDIC */
959 sv_setpv(sv, PL_inplace); /* Will undefine sv if PL_inplace is NULL */
961 case '\014': /* ^LAST_FH */
962 if (strEQ(remaining, "AST_FH")) {
964 assert(isGV_with_GP(PL_last_in_gv));
965 SV_CHECK_THINKFIRST_COW_DROP(sv);
966 prepare_SV_for_RV(sv);
968 SvRV_set(sv, SvREFCNT_inc_simple_NN(PL_last_in_gv));
972 else sv_setsv_nomg(sv, NULL);
975 case '\017': /* ^O & ^OPEN */
976 if (nextchar == '\0') {
977 sv_setpv(sv, PL_osname);
980 else if (strEQ(remaining, "PEN")) {
981 Perl_emulate_cop_io(aTHX_ &PL_compiling, sv);
985 sv_setiv(sv, (IV)PL_perldb);
987 case '\023': /* ^S */
989 if (PL_parser && PL_parser->lex_state != LEX_NOTPARSING)
992 sv_setiv(sv, PL_in_eval & ~(EVAL_INREQUIRE));
997 case '\024': /* ^T */
998 if (nextchar == '\0') {
1000 sv_setnv(sv, PL_basetime);
1002 sv_setiv(sv, (IV)PL_basetime);
1005 else if (strEQ(remaining, "AINT"))
1006 sv_setiv(sv, TAINTING_get
1007 ? (TAINT_WARN_get || PL_unsafe ? -1 : 1)
1010 case '\025': /* $^UNICODE, $^UTF8LOCALE, $^UTF8CACHE */
1011 if (strEQ(remaining, "NICODE"))
1012 sv_setuv(sv, (UV) PL_unicode);
1013 else if (strEQ(remaining, "TF8LOCALE"))
1014 sv_setuv(sv, (UV) PL_utf8locale);
1015 else if (strEQ(remaining, "TF8CACHE"))
1016 sv_setiv(sv, (IV) PL_utf8cache);
1018 case '\027': /* ^W & $^WARNING_BITS */
1019 if (nextchar == '\0')
1020 sv_setiv(sv, (IV)((PL_dowarn & G_WARN_ON) ? TRUE : FALSE));
1021 else if (strEQ(remaining, "ARNING_BITS")) {
1022 if (PL_compiling.cop_warnings == pWARN_NONE) {
1023 sv_setpvn(sv, WARN_NONEstring, WARNsize) ;
1025 else if (PL_compiling.cop_warnings == pWARN_STD) {
1026 sv_setsv(sv, &PL_sv_undef);
1029 else if (PL_compiling.cop_warnings == pWARN_ALL) {
1030 /* Get the bit mask for $warnings::Bits{all}, because
1031 * it could have been extended by warnings::register */
1032 HV * const bits = get_hv("warnings::Bits", 0);
1033 SV ** const bits_all = bits ? hv_fetchs(bits, "all", FALSE) : NULL;
1035 sv_copypv(sv, *bits_all);
1037 sv_setpvn(sv, WARN_ALLstring, WARNsize);
1040 sv_setpvn(sv, (char *) (PL_compiling.cop_warnings + 1),
1041 *PL_compiling.cop_warnings);
1046 if (PL_curpm && (rx = PM_GETRE(PL_curpm))) {
1047 paren = RX_LASTPAREN(rx);
1049 goto do_numbuf_fetch;
1051 sv_setsv(sv,&PL_sv_undef);
1053 case '\016': /* ^N */
1054 if (PL_curpm && (rx = PM_GETRE(PL_curpm))) {
1055 paren = RX_LASTCLOSEPAREN(rx);
1057 goto do_numbuf_fetch;
1059 sv_setsv(sv,&PL_sv_undef);
1062 if (GvIO(PL_last_in_gv)) {
1063 sv_setiv(sv, (IV)IoLINES(GvIOp(PL_last_in_gv)));
1068 sv_setiv(sv, (IV)STATUS_CURRENT);
1069 #ifdef COMPLEX_STATUS
1070 SvUPGRADE(sv, SVt_PVLV);
1071 LvTARGOFF(sv) = PL_statusvalue;
1072 LvTARGLEN(sv) = PL_statusvalue_vms;
1077 if (GvIOp(PL_defoutgv))
1078 s = IoTOP_NAME(GvIOp(PL_defoutgv));
1082 sv_setpv(sv,GvENAME(PL_defoutgv));
1083 sv_catpvs(sv,"_TOP");
1087 if (GvIOp(PL_defoutgv))
1088 s = IoFMT_NAME(GvIOp(PL_defoutgv));
1090 s = GvENAME(PL_defoutgv);
1094 if (GvIO(PL_defoutgv))
1095 sv_setiv(sv, (IV)IoPAGE_LEN(GvIOp(PL_defoutgv)));
1098 if (GvIO(PL_defoutgv))
1099 sv_setiv(sv, (IV)IoLINES_LEFT(GvIOp(PL_defoutgv)));
1102 if (GvIO(PL_defoutgv))
1103 sv_setiv(sv, (IV)IoPAGE(GvIOp(PL_defoutgv)));
1112 if (GvIO(PL_defoutgv))
1113 sv_setiv(sv, (IV)(IoFLAGS(GvIOp(PL_defoutgv)) & IOf_FLUSH) != 0 );
1117 sv_copypv(sv, PL_ors_sv);
1119 sv_setsv(sv, &PL_sv_undef);
1123 IV const pid = (IV)PerlProc_getpid();
1124 if (isGV(mg->mg_obj) || SvIV(mg->mg_obj) != pid) {
1125 /* never set manually, or at least not since last fork */
1127 /* never unsafe, even if reading in a tainted expression */
1130 /* else a value has been assigned manually, so do nothing */
1134 sv_setuid(sv, PerlProc_getuid());
1137 sv_setuid(sv, PerlProc_geteuid());
1140 sv_setgid(sv, PerlProc_getgid());
1143 sv_setgid(sv, PerlProc_getegid());
1145 #ifdef HAS_GETGROUPS
1147 Groups_t *gary = NULL;
1149 I32 num_groups = getgroups(0, gary);
1150 if (num_groups > 0) {
1151 Newx(gary, num_groups, Groups_t);
1152 num_groups = getgroups(num_groups, gary);
1153 for (i = 0; i < num_groups; i++)
1154 Perl_sv_catpvf(aTHX_ sv, " %"IVdf, (IV)gary[i]);
1158 (void)SvIOK_on(sv); /* what a wonderful hack! */
1168 Perl_magic_getuvar(pTHX_ SV *sv, MAGIC *mg)
1170 struct ufuncs * const uf = (struct ufuncs *)mg->mg_ptr;
1172 PERL_ARGS_ASSERT_MAGIC_GETUVAR;
1174 if (uf && uf->uf_val)
1175 (*uf->uf_val)(aTHX_ uf->uf_index, sv);
1180 Perl_magic_setenv(pTHX_ SV *sv, MAGIC *mg)
1182 STRLEN len = 0, klen;
1183 const char * const key = MgPV_const(mg,klen);
1186 PERL_ARGS_ASSERT_MAGIC_SETENV;
1190 /* defined environment variables are byte strings; unfortunately
1191 there is no SvPVbyte_force_nomg(), so we must do this piecewise */
1192 (void)SvPV_force_nomg_nolen(sv);
1193 sv_utf8_downgrade(sv, /* fail_ok */ TRUE);
1195 Perl_ck_warner_d(aTHX_ packWARN(WARN_UTF8), "Wide character in %s", "setenv");
1201 my_setenv(key, s); /* does the deed */
1203 #ifdef DYNAMIC_ENV_FETCH
1204 /* We just undefd an environment var. Is a replacement */
1205 /* waiting in the wings? */
1207 SV ** const valp = hv_fetch(GvHVn(PL_envgv), key, klen, FALSE);
1209 s = SvOK(*valp) ? SvPV_const(*valp, len) : "";
1213 #if !defined(OS2) && !defined(AMIGAOS) && !defined(WIN32) && !defined(MSDOS)
1214 /* And you'll never guess what the dog had */
1215 /* in its mouth... */
1217 MgTAINTEDDIR_off(mg);
1219 if (s && klen == 8 && strEQ(key, "DCL$PATH")) {
1220 char pathbuf[256], eltbuf[256], *cp, *elt;
1223 my_strlcpy(eltbuf, s, sizeof(eltbuf));
1225 do { /* DCL$PATH may be a search list */
1226 while (1) { /* as may dev portion of any element */
1227 if ( ((cp = strchr(elt,'[')) || (cp = strchr(elt,'<'))) ) {
1228 if ( *(cp+1) == '.' || *(cp+1) == '-' ||
1229 cando_by_name(S_IWUSR,0,elt) ) {
1230 MgTAINTEDDIR_on(mg);
1234 if ((cp = strchr(elt, ':')) != NULL)
1236 if (my_trnlnm(elt, eltbuf, j++))
1242 } while (my_trnlnm(s, pathbuf, i++) && (elt = pathbuf));
1245 if (s && klen == 4 && strEQ(key,"PATH")) {
1246 const char * const strend = s + len;
1248 while (s < strend) {
1252 #ifdef VMS /* Hmm. How do we get $Config{path_sep} from C? */
1253 const char path_sep = '|';
1255 const char path_sep = ':';
1257 s = delimcpy(tmpbuf, tmpbuf + sizeof tmpbuf,
1258 s, strend, path_sep, &i);
1260 if (i >= (I32)sizeof tmpbuf /* too long -- assume the worst */
1262 || !strchr(tmpbuf, ':') /* no colon thus no device name -- assume relative path */
1264 || *tmpbuf != '/' /* no starting slash -- assume relative path */
1266 || (PerlLIO_stat(tmpbuf, &st) == 0 && (st.st_mode & 2)) ) {
1267 MgTAINTEDDIR_on(mg);
1273 #endif /* neither OS2 nor AMIGAOS nor WIN32 nor MSDOS */
1279 Perl_magic_clearenv(pTHX_ SV *sv, MAGIC *mg)
1281 PERL_ARGS_ASSERT_MAGIC_CLEARENV;
1282 PERL_UNUSED_ARG(sv);
1283 my_setenv(MgPV_nolen_const(mg),NULL);
1288 Perl_magic_set_all_env(pTHX_ SV *sv, MAGIC *mg)
1290 PERL_ARGS_ASSERT_MAGIC_SET_ALL_ENV;
1291 PERL_UNUSED_ARG(mg);
1293 Perl_die(aTHX_ "Can't make list assignment to %%ENV on this system");
1295 if (PL_localizing) {
1298 hv_iterinit(MUTABLE_HV(sv));
1299 while ((entry = hv_iternext(MUTABLE_HV(sv)))) {
1301 my_setenv(hv_iterkey(entry, &keylen),
1302 SvPV_nolen_const(hv_iterval(MUTABLE_HV(sv), entry)));
1310 Perl_magic_clear_all_env(pTHX_ SV *sv, MAGIC *mg)
1312 PERL_ARGS_ASSERT_MAGIC_CLEAR_ALL_ENV;
1313 PERL_UNUSED_ARG(sv);
1314 PERL_UNUSED_ARG(mg);
1316 Perl_die(aTHX_ "Can't make list assignment to %%ENV on this system");
1324 #ifdef HAS_SIGPROCMASK
1326 restore_sigmask(pTHX_ SV *save_sv)
1328 const sigset_t * const ossetp = (const sigset_t *) SvPV_nolen_const( save_sv );
1329 (void)sigprocmask(SIG_SETMASK, ossetp, NULL);
1333 Perl_magic_getsig(pTHX_ SV *sv, MAGIC *mg)
1335 /* Are we fetching a signal entry? */
1336 int i = (I16)mg->mg_private;
1338 PERL_ARGS_ASSERT_MAGIC_GETSIG;
1342 const char * sig = MgPV_const(mg, siglen);
1343 mg->mg_private = i = whichsig_pvn(sig, siglen);
1348 sv_setsv(sv,PL_psig_ptr[i]);
1350 Sighandler_t sigstate = rsignal_state(i);
1351 #ifdef FAKE_PERSISTENT_SIGNAL_HANDLERS
1352 if (PL_sig_handlers_initted && PL_sig_ignoring[i])
1355 #ifdef FAKE_DEFAULT_SIGNAL_HANDLERS
1356 if (PL_sig_handlers_initted && PL_sig_defaulting[i])
1359 /* cache state so we don't fetch it again */
1360 if(sigstate == (Sighandler_t) SIG_IGN)
1361 sv_setpvs(sv,"IGNORE");
1363 sv_setsv(sv,&PL_sv_undef);
1364 PL_psig_ptr[i] = SvREFCNT_inc_simple_NN(sv);
1371 Perl_magic_clearsig(pTHX_ SV *sv, MAGIC *mg)
1373 PERL_ARGS_ASSERT_MAGIC_CLEARSIG;
1375 magic_setsig(NULL, mg);
1376 return sv_unmagic(sv, mg->mg_type);
1380 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
1381 Perl_csighandler(int sig, siginfo_t *sip PERL_UNUSED_DECL, void *uap PERL_UNUSED_DECL)
1383 Perl_csighandler(int sig)
1386 #ifdef PERL_GET_SIG_CONTEXT
1387 dTHXa(PERL_GET_SIG_CONTEXT);
1391 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
1392 #if defined(__cplusplus) && defined(__GNUC__)
1393 /* g++ doesn't support PERL_UNUSED_DECL, so the sip and uap
1394 * parameters would be warned about. */
1395 PERL_UNUSED_ARG(sip);
1396 PERL_UNUSED_ARG(uap);
1399 #ifdef FAKE_PERSISTENT_SIGNAL_HANDLERS
1400 (void) rsignal(sig, PL_csighandlerp);
1401 if (PL_sig_ignoring[sig]) return;
1403 #ifdef FAKE_DEFAULT_SIGNAL_HANDLERS
1404 if (PL_sig_defaulting[sig])
1405 #ifdef KILL_BY_SIGPRC
1406 exit((Perl_sig_to_vmscondition(sig)&STS$M_COND_ID)|STS$K_SEVERE|STS$M_INHIB_MSG);
1421 (PL_signals & PERL_SIGNALS_UNSAFE_FLAG))
1422 /* Call the perl level handler now--
1423 * with risk we may be in malloc() or being destructed etc. */
1424 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
1425 (*PL_sighandlerp)(sig, NULL, NULL);
1427 (*PL_sighandlerp)(sig);
1430 if (!PL_psig_pend) return;
1431 /* Set a flag to say this signal is pending, that is awaiting delivery after
1432 * the current Perl opcode completes */
1433 PL_psig_pend[sig]++;
1435 #ifndef SIG_PENDING_DIE_COUNT
1436 # define SIG_PENDING_DIE_COUNT 120
1438 /* Add one to say _a_ signal is pending */
1439 if (++PL_sig_pending >= SIG_PENDING_DIE_COUNT)
1440 Perl_croak(aTHX_ "Maximal count of pending signals (%lu) exceeded",
1441 (unsigned long)SIG_PENDING_DIE_COUNT);
1445 #if defined(FAKE_PERSISTENT_SIGNAL_HANDLERS) || defined(FAKE_DEFAULT_SIGNAL_HANDLERS)
1447 Perl_csighandler_init(void)
1450 if (PL_sig_handlers_initted) return;
1452 for (sig = 1; sig < SIG_SIZE; sig++) {
1453 #ifdef FAKE_DEFAULT_SIGNAL_HANDLERS
1455 PL_sig_defaulting[sig] = 1;
1456 (void) rsignal(sig, PL_csighandlerp);
1458 #ifdef FAKE_PERSISTENT_SIGNAL_HANDLERS
1459 PL_sig_ignoring[sig] = 0;
1462 PL_sig_handlers_initted = 1;
1466 #if defined HAS_SIGPROCMASK
1468 unblock_sigmask(pTHX_ void* newset)
1470 PERL_UNUSED_CONTEXT;
1471 sigprocmask(SIG_UNBLOCK, (sigset_t*)newset, NULL);
1476 Perl_despatch_signals(pTHX)
1480 for (sig = 1; sig < SIG_SIZE; sig++) {
1481 if (PL_psig_pend[sig]) {
1483 #ifdef HAS_SIGPROCMASK
1484 /* From sigaction(2) (FreeBSD man page):
1485 * | Signal routines normally execute with the signal that
1486 * | caused their invocation blocked, but other signals may
1488 * Emulation of this behavior (from within Perl) is enabled
1492 sigset_t newset, oldset;
1494 sigemptyset(&newset);
1495 sigaddset(&newset, sig);
1496 sigprocmask(SIG_BLOCK, &newset, &oldset);
1497 was_blocked = sigismember(&oldset, sig);
1499 SV* save_sv = newSVpvn((char *)(&newset), sizeof(sigset_t));
1501 SAVEFREESV(save_sv);
1502 SAVEDESTRUCTOR_X(unblock_sigmask, SvPV_nolen(save_sv));
1505 PL_psig_pend[sig] = 0;
1506 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
1507 (*PL_sighandlerp)(sig, NULL, NULL);
1509 (*PL_sighandlerp)(sig);
1511 #ifdef HAS_SIGPROCMASK
1520 /* sv of NULL signifies that we're acting as magic_clearsig. */
1522 Perl_magic_setsig(pTHX_ SV *sv, MAGIC *mg)
1527 /* Need to be careful with SvREFCNT_dec(), because that can have side
1528 * effects (due to closures). We must make sure that the new disposition
1529 * is in place before it is called.
1533 #ifdef HAS_SIGPROCMASK
1537 const char *s = MgPV_const(mg,len);
1539 PERL_ARGS_ASSERT_MAGIC_SETSIG;
1542 if (memEQs(s, len, "__DIE__"))
1544 else if (memEQs(s, len, "__WARN__")
1545 && (sv ? 1 : PL_warnhook != PERL_WARNHOOK_FATAL)) {
1546 /* Merge the existing behaviours, which are as follows:
1547 magic_setsig, we always set svp to &PL_warnhook
1548 (hence we always change the warnings handler)
1549 For magic_clearsig, we don't change the warnings handler if it's
1550 set to the &PL_warnhook. */
1553 SV *tmp = sv_newmortal();
1554 Perl_croak(aTHX_ "No such hook: %s",
1555 pv_pretty(tmp, s, len, 0, NULL, NULL, 0));
1559 if (*svp != PERL_WARNHOOK_FATAL)
1565 i = (I16)mg->mg_private;
1567 i = whichsig_pvn(s, len); /* ...no, a brick */
1568 mg->mg_private = (U16)i;
1572 SV *tmp = sv_newmortal();
1573 Perl_ck_warner(aTHX_ packWARN(WARN_SIGNAL), "No such signal: SIG%s",
1574 pv_pretty(tmp, s, len, 0, NULL, NULL, 0));
1578 #ifdef HAS_SIGPROCMASK
1579 /* Avoid having the signal arrive at a bad time, if possible. */
1582 sigprocmask(SIG_BLOCK, &set, &save);
1584 save_sv = newSVpvn((char *)(&save), sizeof(sigset_t));
1585 SAVEFREESV(save_sv);
1586 SAVEDESTRUCTOR_X(restore_sigmask, save_sv);
1589 #if defined(FAKE_PERSISTENT_SIGNAL_HANDLERS) || defined(FAKE_DEFAULT_SIGNAL_HANDLERS)
1590 if (!PL_sig_handlers_initted) Perl_csighandler_init();
1592 #ifdef FAKE_PERSISTENT_SIGNAL_HANDLERS
1593 PL_sig_ignoring[i] = 0;
1595 #ifdef FAKE_DEFAULT_SIGNAL_HANDLERS
1596 PL_sig_defaulting[i] = 0;
1598 to_dec = PL_psig_ptr[i];
1600 PL_psig_ptr[i] = SvREFCNT_inc_simple_NN(sv);
1601 SvTEMP_off(sv); /* Make sure it doesn't go away on us */
1603 /* Signals don't change name during the program's execution, so once
1604 they're cached in the appropriate slot of PL_psig_name, they can
1607 Ideally we'd find some way of making SVs at (C) compile time, or
1608 at least, doing most of the work. */
1609 if (!PL_psig_name[i]) {
1610 PL_psig_name[i] = newSVpvn(s, len);
1611 SvREADONLY_on(PL_psig_name[i]);
1614 SvREFCNT_dec(PL_psig_name[i]);
1615 PL_psig_name[i] = NULL;
1616 PL_psig_ptr[i] = NULL;
1619 if (sv && (isGV_with_GP(sv) || SvROK(sv))) {
1621 (void)rsignal(i, PL_csighandlerp);
1624 *svp = SvREFCNT_inc_simple_NN(sv);
1626 if (sv && SvOK(sv)) {
1627 s = SvPV_force(sv, len);
1631 if (sv && memEQs(s, len,"IGNORE")) {
1633 #ifdef FAKE_PERSISTENT_SIGNAL_HANDLERS
1634 PL_sig_ignoring[i] = 1;
1635 (void)rsignal(i, PL_csighandlerp);
1637 (void)rsignal(i, (Sighandler_t) SIG_IGN);
1641 else if (!sv || memEQs(s, len,"DEFAULT") || !len) {
1643 #ifdef FAKE_DEFAULT_SIGNAL_HANDLERS
1644 PL_sig_defaulting[i] = 1;
1645 (void)rsignal(i, PL_csighandlerp);
1647 (void)rsignal(i, (Sighandler_t) SIG_DFL);
1653 * We should warn if HINT_STRICT_REFS, but without
1654 * access to a known hint bit in a known OP, we can't
1655 * tell whether HINT_STRICT_REFS is in force or not.
1657 if (!strchr(s,':') && !strchr(s,'\''))
1658 Perl_sv_insert_flags(aTHX_ sv, 0, 0, STR_WITH_LEN("main::"),
1661 (void)rsignal(i, PL_csighandlerp);
1663 *svp = SvREFCNT_inc_simple_NN(sv);
1667 #ifdef HAS_SIGPROCMASK
1671 SvREFCNT_dec(to_dec);
1674 #endif /* !PERL_MICRO */
1677 Perl_magic_setisa(pTHX_ SV *sv, MAGIC *mg)
1679 PERL_ARGS_ASSERT_MAGIC_SETISA;
1680 PERL_UNUSED_ARG(sv);
1682 /* Skip _isaelem because _isa will handle it shortly */
1683 if (PL_delaymagic & DM_ARRAY_ISA && mg->mg_type == PERL_MAGIC_isaelem)
1686 return magic_clearisa(NULL, mg);
1689 /* sv of NULL signifies that we're acting as magic_setisa. */
1691 Perl_magic_clearisa(pTHX_ SV *sv, MAGIC *mg)
1694 PERL_ARGS_ASSERT_MAGIC_CLEARISA;
1696 /* Bail out if destruction is going on */
1697 if(PL_phase == PERL_PHASE_DESTRUCT) return 0;
1700 av_clear(MUTABLE_AV(sv));
1702 if (SvTYPE(mg->mg_obj) != SVt_PVGV && SvSMAGICAL(mg->mg_obj))
1703 /* This occurs with setisa_elem magic, which calls this
1705 mg = mg_find(mg->mg_obj, PERL_MAGIC_isa);
1708 if (SvTYPE(mg->mg_obj) == SVt_PVAV) { /* multiple stashes */
1709 SV **svp = AvARRAY((AV *)mg->mg_obj);
1710 I32 items = AvFILLp((AV *)mg->mg_obj) + 1;
1712 stash = GvSTASH((GV *)*svp++);
1713 if (stash && HvENAME(stash)) mro_isa_changed_in(stash);
1720 (const GV *)mg->mg_obj
1723 /* The stash may have been detached from the symbol table, so check its
1724 name before doing anything. */
1725 if (stash && HvENAME_get(stash))
1726 mro_isa_changed_in(stash);
1732 Perl_magic_getnkeys(pTHX_ SV *sv, MAGIC *mg)
1734 HV * const hv = MUTABLE_HV(LvTARG(sv));
1737 PERL_ARGS_ASSERT_MAGIC_GETNKEYS;
1738 PERL_UNUSED_ARG(mg);
1741 (void) hv_iterinit(hv);
1742 if (! SvTIED_mg((const SV *)hv, PERL_MAGIC_tied))
1745 while (hv_iternext(hv))
1750 sv_setiv(sv, (IV)i);
1755 Perl_magic_setnkeys(pTHX_ SV *sv, MAGIC *mg)
1757 PERL_ARGS_ASSERT_MAGIC_SETNKEYS;
1758 PERL_UNUSED_ARG(mg);
1760 hv_ksplit(MUTABLE_HV(LvTARG(sv)), SvIV(sv));
1766 =for apidoc magic_methcall
1768 Invoke a magic method (like FETCH).
1770 C<sv> and C<mg> are the tied thingy and the tie magic.
1772 C<meth> is the name of the method to call.
1774 C<argc> is the number of args (in addition to $self) to pass to the method.
1776 The C<flags> can be:
1778 G_DISCARD invoke method with G_DISCARD flag and don't
1780 G_UNDEF_FILL fill the stack with argc pointers to
1783 The arguments themselves are any values following the C<flags> argument.
1785 Returns the SV (if any) returned by the method, or NULL on failure.
1792 Perl_magic_methcall(pTHX_ SV *sv, const MAGIC *mg, SV *meth, U32 flags,
1798 PERL_ARGS_ASSERT_MAGIC_METHCALL;
1802 if (flags & G_WRITING_TO_STDERR) {
1805 SAVESPTR(PL_stderrgv);
1809 PUSHSTACKi(PERLSI_MAGIC);
1813 PUSHs(SvTIED_obj(sv, mg));
1814 if (flags & G_UNDEF_FILL) {
1816 PUSHs(&PL_sv_undef);
1818 } else if (argc > 0) {
1820 va_start(args, argc);
1823 SV *const sv = va_arg(args, SV *);
1830 if (flags & G_DISCARD) {
1831 call_sv(meth, G_SCALAR|G_DISCARD|G_METHOD_NAMED);
1834 if (call_sv(meth, G_SCALAR|G_METHOD_NAMED))
1835 ret = *PL_stack_sp--;
1838 if (flags & G_WRITING_TO_STDERR)
1844 /* wrapper for magic_methcall that creates the first arg */
1847 S_magic_methcall1(pTHX_ SV *sv, const MAGIC *mg, SV *meth, U32 flags,
1852 PERL_ARGS_ASSERT_MAGIC_METHCALL1;
1855 if (mg->mg_len >= 0) {
1856 arg1 = newSVpvn_flags(mg->mg_ptr, mg->mg_len, SVs_TEMP);
1858 else if (mg->mg_len == HEf_SVKEY)
1859 arg1 = MUTABLE_SV(mg->mg_ptr);
1861 else if (mg->mg_type == PERL_MAGIC_tiedelem) {
1862 arg1 = newSViv((IV)(mg->mg_len));
1866 return Perl_magic_methcall(aTHX_ sv, mg, meth, flags, n - 1, val);
1868 return Perl_magic_methcall(aTHX_ sv, mg, meth, flags, n, arg1, val);
1872 S_magic_methpack(pTHX_ SV *sv, const MAGIC *mg, SV *meth)
1876 PERL_ARGS_ASSERT_MAGIC_METHPACK;
1878 ret = magic_methcall1(sv, mg, meth, 0, 1, NULL);
1885 Perl_magic_getpack(pTHX_ SV *sv, MAGIC *mg)
1887 PERL_ARGS_ASSERT_MAGIC_GETPACK;
1889 if (mg->mg_type == PERL_MAGIC_tiedelem)
1890 mg->mg_flags |= MGf_GSKIP;
1891 magic_methpack(sv,mg,SV_CONST(FETCH));
1896 Perl_magic_setpack(pTHX_ SV *sv, MAGIC *mg)
1901 PERL_ARGS_ASSERT_MAGIC_SETPACK;
1903 /* in the code C<$tied{foo} = $val>, the "thing" that gets passed to
1904 * STORE() is not $val, but rather a PVLV (the sv in this call), whose
1905 * public flags indicate its value based on copying from $val. Doing
1906 * mg_set() on the PVLV temporarily does SvMAGICAL_off(), then calls us.
1907 * So STORE()'s $_[2] arg is a temporarily disarmed PVLV. This goes
1908 * wrong if $val happened to be tainted, as sv hasn't got magic
1909 * enabled, even though taint magic is in the chain. In which case,
1910 * fake up a temporary tainted value (this is easier than temporarily
1911 * re-enabling magic on sv). */
1913 if (TAINTING_get && (tmg = mg_find(sv, PERL_MAGIC_taint))
1914 && (tmg->mg_len & 1))
1916 val = sv_mortalcopy(sv);
1922 magic_methcall1(sv, mg, SV_CONST(STORE), G_DISCARD, 2, val);
1927 Perl_magic_clearpack(pTHX_ SV *sv, MAGIC *mg)
1929 PERL_ARGS_ASSERT_MAGIC_CLEARPACK;
1931 if (mg->mg_type == PERL_MAGIC_tiedscalar) return 0;
1932 return magic_methpack(sv,mg,SV_CONST(DELETE));
1937 Perl_magic_sizepack(pTHX_ SV *sv, MAGIC *mg)
1942 PERL_ARGS_ASSERT_MAGIC_SIZEPACK;
1944 retsv = magic_methcall1(sv, mg, SV_CONST(FETCHSIZE), 0, 1, NULL);
1946 retval = SvIV(retsv)-1;
1948 Perl_croak(aTHX_ "FETCHSIZE returned a negative value");
1950 return (U32) retval;
1954 Perl_magic_wipepack(pTHX_ SV *sv, MAGIC *mg)
1956 PERL_ARGS_ASSERT_MAGIC_WIPEPACK;
1958 Perl_magic_methcall(aTHX_ sv, mg, SV_CONST(CLEAR), G_DISCARD, 0);
1963 Perl_magic_nextpack(pTHX_ SV *sv, MAGIC *mg, SV *key)
1967 PERL_ARGS_ASSERT_MAGIC_NEXTPACK;
1969 ret = SvOK(key) ? Perl_magic_methcall(aTHX_ sv, mg, SV_CONST(NEXTKEY), 0, 1, key)
1970 : Perl_magic_methcall(aTHX_ sv, mg, SV_CONST(FIRSTKEY), 0, 0);
1977 Perl_magic_existspack(pTHX_ SV *sv, const MAGIC *mg)
1979 PERL_ARGS_ASSERT_MAGIC_EXISTSPACK;
1981 return magic_methpack(sv,mg,SV_CONST(EXISTS));
1985 Perl_magic_scalarpack(pTHX_ HV *hv, MAGIC *mg)
1988 SV * const tied = SvTIED_obj(MUTABLE_SV(hv), mg);
1989 HV * const pkg = SvSTASH((const SV *)SvRV(tied));
1991 PERL_ARGS_ASSERT_MAGIC_SCALARPACK;
1993 if (!gv_fetchmethod_autoload(pkg, "SCALAR", FALSE)) {
1995 if (HvEITER_get(hv))
1996 /* we are in an iteration so the hash cannot be empty */
1998 /* no xhv_eiter so now use FIRSTKEY */
1999 key = sv_newmortal();
2000 magic_nextpack(MUTABLE_SV(hv), mg, key);
2001 HvEITER_set(hv, NULL); /* need to reset iterator */
2002 return SvOK(key) ? &PL_sv_yes : &PL_sv_no;
2005 /* there is a SCALAR method that we can call */
2006 retval = Perl_magic_methcall(aTHX_ MUTABLE_SV(hv), mg, SV_CONST(SCALAR), 0, 0);
2008 retval = &PL_sv_undef;
2013 Perl_magic_setdbline(pTHX_ SV *sv, MAGIC *mg)
2017 PERL_ARGS_ASSERT_MAGIC_SETDBLINE;
2019 /* The magic ptr/len for the debugger's hash should always be an SV. */
2020 if (UNLIKELY(mg->mg_len != HEf_SVKEY)) {
2021 Perl_croak(aTHX_ "panic: magic_setdbline len=%"IVdf", ptr='%s'",
2022 (IV)mg->mg_len, mg->mg_ptr);
2025 /* Use sv_2iv instead of SvIV() as the former generates smaller code, and
2026 setting/clearing debugger breakpoints is not a hot path. */
2027 svp = av_fetch(MUTABLE_AV(mg->mg_obj),
2028 sv_2iv(MUTABLE_SV((mg)->mg_ptr)), FALSE);
2030 if (svp && SvIOKp(*svp)) {
2031 OP * const o = INT2PTR(OP*,SvIVX(*svp));
2033 #ifdef PERL_DEBUG_READONLY_OPS
2034 Slab_to_rw(OpSLAB(o));
2036 /* set or clear breakpoint in the relevant control op */
2038 o->op_flags |= OPf_SPECIAL;
2040 o->op_flags &= ~OPf_SPECIAL;
2041 #ifdef PERL_DEBUG_READONLY_OPS
2042 Slab_to_ro(OpSLAB(o));
2050 Perl_magic_getarylen(pTHX_ SV *sv, const MAGIC *mg)
2052 AV * const obj = MUTABLE_AV(mg->mg_obj);
2054 PERL_ARGS_ASSERT_MAGIC_GETARYLEN;
2057 sv_setiv(sv, AvFILL(obj));
2065 Perl_magic_setarylen(pTHX_ SV *sv, MAGIC *mg)
2067 AV * const obj = MUTABLE_AV(mg->mg_obj);
2069 PERL_ARGS_ASSERT_MAGIC_SETARYLEN;
2072 av_fill(obj, SvIV(sv));
2074 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
2075 "Attempt to set length of freed array");
2081 Perl_magic_cleararylen_p(pTHX_ SV *sv, MAGIC *mg)
2083 PERL_ARGS_ASSERT_MAGIC_CLEARARYLEN_P;
2084 PERL_UNUSED_ARG(sv);
2085 PERL_UNUSED_CONTEXT;
2087 /* Reset the iterator when the array is cleared */
2088 #if IVSIZE == I32SIZE
2089 *((IV *) &(mg->mg_len)) = 0;
2092 *((IV *) mg->mg_ptr) = 0;
2099 Perl_magic_freearylen_p(pTHX_ SV *sv, MAGIC *mg)
2101 PERL_ARGS_ASSERT_MAGIC_FREEARYLEN_P;
2102 PERL_UNUSED_ARG(sv);
2104 /* during global destruction, mg_obj may already have been freed */
2105 if (PL_in_clean_all)
2108 mg = mg_find (mg->mg_obj, PERL_MAGIC_arylen);
2111 /* arylen scalar holds a pointer back to the array, but doesn't own a
2112 reference. Hence the we (the array) are about to go away with it
2113 still pointing at us. Clear its pointer, else it would be pointing
2114 at free memory. See the comment in sv_magic about reference loops,
2115 and why it can't own a reference to us. */
2122 Perl_magic_getpos(pTHX_ SV *sv, MAGIC *mg)
2124 SV* const lsv = LvTARG(sv);
2125 MAGIC * const found = mg_find_mglob(lsv);
2127 PERL_ARGS_ASSERT_MAGIC_GETPOS;
2128 PERL_UNUSED_ARG(mg);
2130 if (found && found->mg_len != -1) {
2131 STRLEN i = found->mg_len;
2132 if (found->mg_flags & MGf_BYTES && DO_UTF8(lsv))
2133 i = sv_pos_b2u_flags(lsv, i, SV_GMAGIC|SV_CONST_RETURN);
2142 Perl_magic_setpos(pTHX_ SV *sv, MAGIC *mg)
2144 SV* const lsv = LvTARG(sv);
2151 PERL_ARGS_ASSERT_MAGIC_SETPOS;
2152 PERL_UNUSED_ARG(mg);
2154 found = mg_find_mglob(lsv);
2158 found = sv_magicext_mglob(lsv);
2160 else if (!SvOK(sv)) {
2164 s = SvPV_const(lsv, len);
2169 ulen = sv_or_pv_len_utf8(lsv, s, len);
2179 else if (pos > (SSize_t)len)
2182 found->mg_len = pos;
2183 found->mg_flags &= ~(MGf_MINMATCH|MGf_BYTES);
2189 Perl_magic_getsubstr(pTHX_ SV *sv, MAGIC *mg)
2192 SV * const lsv = LvTARG(sv);
2193 const char * const tmps = SvPV_const(lsv,len);
2194 STRLEN offs = LvTARGOFF(sv);
2195 STRLEN rem = LvTARGLEN(sv);
2196 const bool negoff = LvFLAGS(sv) & 1;
2197 const bool negrem = LvFLAGS(sv) & 2;
2199 PERL_ARGS_ASSERT_MAGIC_GETSUBSTR;
2200 PERL_UNUSED_ARG(mg);
2202 if (!translate_substr_offsets(
2203 SvUTF8(lsv) ? sv_or_pv_len_utf8(lsv, tmps, len) : len,
2204 negoff ? -(IV)offs : (IV)offs, !negoff,
2205 negrem ? -(IV)rem : (IV)rem, !negrem, &offs, &rem
2207 Perl_ck_warner(aTHX_ packWARN(WARN_SUBSTR), "substr outside of string");
2208 sv_setsv_nomg(sv, &PL_sv_undef);
2213 offs = sv_or_pv_pos_u2b(lsv, tmps, offs, &rem);
2214 sv_setpvn(sv, tmps + offs, rem);
2221 Perl_magic_setsubstr(pTHX_ SV *sv, MAGIC *mg)
2223 STRLEN len, lsv_len, oldtarglen, newtarglen;
2224 const char * const tmps = SvPV_const(sv, len);
2225 SV * const lsv = LvTARG(sv);
2226 STRLEN lvoff = LvTARGOFF(sv);
2227 STRLEN lvlen = LvTARGLEN(sv);
2228 const bool negoff = LvFLAGS(sv) & 1;
2229 const bool neglen = LvFLAGS(sv) & 2;
2231 PERL_ARGS_ASSERT_MAGIC_SETSUBSTR;
2232 PERL_UNUSED_ARG(mg);
2236 Perl_ck_warner(aTHX_ packWARN(WARN_SUBSTR),
2237 "Attempt to use reference as lvalue in substr"
2239 SvPV_force_nomg(lsv,lsv_len);
2240 if (SvUTF8(lsv)) lsv_len = sv_len_utf8_nomg(lsv);
2241 if (!translate_substr_offsets(
2243 negoff ? -(IV)lvoff : (IV)lvoff, !negoff,
2244 neglen ? -(IV)lvlen : (IV)lvlen, !neglen, &lvoff, &lvlen
2246 Perl_croak(aTHX_ "substr outside of string");
2249 sv_utf8_upgrade_nomg(lsv);
2250 lvoff = sv_pos_u2b_flags(lsv, lvoff, &lvlen, SV_CONST_RETURN);
2251 sv_insert_flags(lsv, lvoff, lvlen, tmps, len, 0);
2252 newtarglen = sv_or_pv_len_utf8(sv, tmps, len);
2255 else if (SvUTF8(lsv)) {
2257 lvoff = sv_pos_u2b_flags(lsv, lvoff, &lvlen, SV_CONST_RETURN);
2259 utf8 = (char*)bytes_to_utf8((U8*)tmps, &len);
2260 sv_insert_flags(lsv, lvoff, lvlen, utf8, len, 0);
2264 sv_insert_flags(lsv, lvoff, lvlen, tmps, len, 0);
2267 if (!neglen) LvTARGLEN(sv) = newtarglen;
2268 if (negoff) LvTARGOFF(sv) += newtarglen - oldtarglen;
2274 Perl_magic_gettaint(pTHX_ SV *sv, MAGIC *mg)
2276 PERL_ARGS_ASSERT_MAGIC_GETTAINT;
2277 PERL_UNUSED_ARG(sv);
2278 #ifdef NO_TAINT_SUPPORT
2279 PERL_UNUSED_ARG(mg);
2282 TAINT_IF((PL_localizing != 1) && (mg->mg_len & 1) && IN_PERL_RUNTIME);
2287 Perl_magic_settaint(pTHX_ SV *sv, MAGIC *mg)
2289 PERL_ARGS_ASSERT_MAGIC_SETTAINT;
2290 PERL_UNUSED_ARG(sv);
2292 /* update taint status */
2301 Perl_magic_getvec(pTHX_ SV *sv, MAGIC *mg)
2303 SV * const lsv = LvTARG(sv);
2305 PERL_ARGS_ASSERT_MAGIC_GETVEC;
2306 PERL_UNUSED_ARG(mg);
2308 sv_setuv(sv, do_vecget(lsv, LvTARGOFF(sv), LvTARGLEN(sv)));
2314 Perl_magic_setvec(pTHX_ SV *sv, MAGIC *mg)
2316 PERL_ARGS_ASSERT_MAGIC_SETVEC;
2317 PERL_UNUSED_ARG(mg);
2318 do_vecset(sv); /* XXX slurp this routine */
2323 Perl_defelem_target(pTHX_ SV *sv, MAGIC *mg)
2326 PERL_ARGS_ASSERT_DEFELEM_TARGET;
2327 if (!mg) mg = mg_find(sv, PERL_MAGIC_defelem);
2329 if (LvTARGLEN(sv)) {
2331 SV * const ahv = LvTARG(sv);
2332 HE * const he = hv_fetch_ent(MUTABLE_HV(ahv), mg->mg_obj, FALSE, 0);
2336 else if (LvSTARGOFF(sv) >= 0) {
2337 AV *const av = MUTABLE_AV(LvTARG(sv));
2338 if (LvSTARGOFF(sv) <= AvFILL(av))
2340 if (SvRMAGICAL(av)) {
2341 SV * const * const svp = av_fetch(av, LvSTARGOFF(sv), 0);
2342 targ = svp ? *svp : NULL;
2345 targ = AvARRAY(av)[LvSTARGOFF(sv)];
2348 if (targ && (targ != &PL_sv_undef)) {
2349 /* somebody else defined it for us */
2350 SvREFCNT_dec(LvTARG(sv));
2351 LvTARG(sv) = SvREFCNT_inc_simple_NN(targ);
2353 SvREFCNT_dec(mg->mg_obj);
2355 mg->mg_flags &= ~MGf_REFCOUNTED;
2364 Perl_magic_getdefelem(pTHX_ SV *sv, MAGIC *mg)
2366 PERL_ARGS_ASSERT_MAGIC_GETDEFELEM;
2368 sv_setsv(sv, defelem_target(sv, mg));
2373 Perl_magic_setdefelem(pTHX_ SV *sv, MAGIC *mg)
2375 PERL_ARGS_ASSERT_MAGIC_SETDEFELEM;
2376 PERL_UNUSED_ARG(mg);
2380 sv_setsv(LvTARG(sv), sv);
2381 SvSETMAGIC(LvTARG(sv));
2387 Perl_vivify_defelem(pTHX_ SV *sv)
2392 PERL_ARGS_ASSERT_VIVIFY_DEFELEM;
2394 if (!LvTARGLEN(sv) || !(mg = mg_find(sv, PERL_MAGIC_defelem)))
2397 SV * const ahv = LvTARG(sv);
2398 HE * const he = hv_fetch_ent(MUTABLE_HV(ahv), mg->mg_obj, TRUE, 0);
2401 if (!value || value == &PL_sv_undef)
2402 Perl_croak(aTHX_ PL_no_helem_sv, SVfARG(mg->mg_obj));
2404 else if (LvSTARGOFF(sv) < 0)
2405 Perl_croak(aTHX_ PL_no_aelem, LvSTARGOFF(sv));
2407 AV *const av = MUTABLE_AV(LvTARG(sv));
2408 if ((I32)LvTARGLEN(sv) < 0 && LvSTARGOFF(sv) > AvFILL(av))
2409 LvTARG(sv) = NULL; /* array can't be extended */
2411 SV* const * const svp = av_fetch(av, LvSTARGOFF(sv), TRUE);
2412 if (!svp || !(value = *svp))
2413 Perl_croak(aTHX_ PL_no_aelem, LvSTARGOFF(sv));
2416 SvREFCNT_inc_simple_void(value);
2417 SvREFCNT_dec(LvTARG(sv));
2420 SvREFCNT_dec(mg->mg_obj);
2422 mg->mg_flags &= ~MGf_REFCOUNTED;
2426 Perl_magic_killbackrefs(pTHX_ SV *sv, MAGIC *mg)
2428 PERL_ARGS_ASSERT_MAGIC_KILLBACKREFS;
2429 Perl_sv_kill_backrefs(aTHX_ sv, MUTABLE_AV(mg->mg_obj));
2434 Perl_magic_setmglob(pTHX_ SV *sv, MAGIC *mg)
2436 PERL_ARGS_ASSERT_MAGIC_SETMGLOB;
2437 PERL_UNUSED_CONTEXT;
2438 PERL_UNUSED_ARG(sv);
2444 Perl_magic_setuvar(pTHX_ SV *sv, MAGIC *mg)
2446 const struct ufuncs * const uf = (struct ufuncs *)mg->mg_ptr;
2448 PERL_ARGS_ASSERT_MAGIC_SETUVAR;
2450 if (uf && uf->uf_set)
2451 (*uf->uf_set)(aTHX_ uf->uf_index, sv);
2456 Perl_magic_setregexp(pTHX_ SV *sv, MAGIC *mg)
2458 const char type = mg->mg_type;
2460 PERL_ARGS_ASSERT_MAGIC_SETREGEXP;
2462 if (type == PERL_MAGIC_qr) {
2463 } else if (type == PERL_MAGIC_bm) {
2467 assert(type == PERL_MAGIC_fm);
2469 return sv_unmagic(sv, type);
2472 #ifdef USE_LOCALE_COLLATE
2474 Perl_magic_setcollxfrm(pTHX_ SV *sv, MAGIC *mg)
2476 PERL_ARGS_ASSERT_MAGIC_SETCOLLXFRM;
2479 * RenE<eacute> Descartes said "I think not."
2480 * and vanished with a faint plop.
2482 PERL_UNUSED_CONTEXT;
2483 PERL_UNUSED_ARG(sv);
2485 Safefree(mg->mg_ptr);
2491 #endif /* USE_LOCALE_COLLATE */
2493 /* Just clear the UTF-8 cache data. */
2495 Perl_magic_setutf8(pTHX_ SV *sv, MAGIC *mg)
2497 PERL_ARGS_ASSERT_MAGIC_SETUTF8;
2498 PERL_UNUSED_CONTEXT;
2499 PERL_UNUSED_ARG(sv);
2500 Safefree(mg->mg_ptr); /* The mg_ptr holds the pos cache. */
2502 mg->mg_len = -1; /* The mg_len holds the len cache. */
2507 Perl_magic_setlvref(pTHX_ SV *sv, MAGIC *mg)
2509 const char *bad = NULL;
2510 PERL_ARGS_ASSERT_MAGIC_SETLVREF;
2511 if (!SvROK(sv)) Perl_croak(aTHX_ "Assigned value is not a reference");
2512 switch (mg->mg_private & OPpLVREF_TYPE) {
2514 if (SvTYPE(SvRV(sv)) > SVt_PVLV)
2518 if (SvTYPE(SvRV(sv)) != SVt_PVAV)
2522 if (SvTYPE(SvRV(sv)) != SVt_PVHV)
2526 if (SvTYPE(SvRV(sv)) != SVt_PVCV)
2530 /* diag_listed_as: Assigned value is not %s reference */
2531 Perl_croak(aTHX_ "Assigned value is not a%s reference", bad);
2532 switch (mg->mg_obj ? SvTYPE(mg->mg_obj) : 0) {
2535 SV * const old = PAD_SV(mg->mg_len);
2536 PAD_SETSV(mg->mg_len, SvREFCNT_inc_NN(SvRV(sv)));
2541 gv_setref(mg->mg_obj, sv);
2542 SvSETMAGIC(mg->mg_obj);
2545 av_store((AV *)mg->mg_obj, SvIV((SV *)mg->mg_ptr),
2546 SvREFCNT_inc_simple_NN(SvRV(sv)));
2549 (void)hv_store_ent((HV *)mg->mg_obj, (SV *)mg->mg_ptr,
2550 SvREFCNT_inc_simple_NN(SvRV(sv)), 0);
2552 if (mg->mg_flags & MGf_PERSIST)
2553 NOOP; /* This sv is in use as an iterator var and will be reused,
2554 so we must leave the magic. */
2556 /* This sv could be returned by the assignment op, so clear the
2557 magic, as lvrefs are an implementation detail that must not be
2558 leaked to the user. */
2559 sv_unmagic(sv, PERL_MAGIC_lvref);
2564 Perl_magic_set(pTHX_ SV *sv, MAGIC *mg)
2576 PERL_ARGS_ASSERT_MAGIC_SET;
2580 if (PL_curpm && (rx = PM_GETRE(PL_curpm))) {
2582 CALLREG_NUMBUF_STORE((REGEXP * const)rx,paren,sv);
2584 /* Croak with a READONLY error when a numbered match var is
2585 * set without a previous pattern match. Unless it's C<local $1>
2588 if (!PL_localizing) {
2589 Perl_croak_no_modify();
2595 switch (*mg->mg_ptr) {
2596 case '\001': /* ^A */
2597 if (SvOK(sv)) sv_copypv(PL_bodytarget, sv);
2598 else SvOK_off(PL_bodytarget);
2599 FmLINES(PL_bodytarget) = 0;
2600 if (SvPOK(PL_bodytarget)) {
2601 char *s = SvPVX(PL_bodytarget);
2602 while ( ((s = strchr(s, '\n'))) ) {
2603 FmLINES(PL_bodytarget)++;
2607 /* mg_set() has temporarily made sv non-magical */
2609 if ((tmg = mg_find(sv,PERL_MAGIC_taint)) && tmg->mg_len & 1)
2610 SvTAINTED_on(PL_bodytarget);
2612 SvTAINTED_off(PL_bodytarget);
2615 case '\003': /* ^C */
2616 PL_minus_c = cBOOL(SvIV(sv));
2619 case '\004': /* ^D */
2621 s = SvPV_nolen_const(sv);
2622 PL_debug = get_debug_opts(&s, 0) | DEBUG_TOP_FLAG;
2623 if (DEBUG_x_TEST || DEBUG_B_TEST)
2624 dump_all_perl(!DEBUG_B_TEST);
2626 PL_debug = (SvIV(sv)) | DEBUG_TOP_FLAG;
2629 case '\005': /* ^E */
2630 if (*(mg->mg_ptr+1) == '\0') {
2632 set_vaxc_errno(SvIV(sv));
2635 SetLastError( SvIV(sv) );
2638 os2_setsyserrno(SvIV(sv));
2640 /* will anyone ever use this? */
2641 SETERRNO(SvIV(sv), 4);
2647 unsigned int offset = 1;
2650 /* It may be the shadow variable ${E_NCODING} which has lexical
2651 * scope. See comments at Perl__get_encoding in this file */
2652 if (*(mg->mg_ptr + 1) == '_') {
2653 if (CopSTASH(PL_curcop) != get_hv("encoding::",0))
2654 Perl_croak_no_modify();
2658 if (strEQ(mg->mg_ptr + offset, "NCODING")) {
2659 if (lex) { /* Use the shadow global */
2660 SvREFCNT_dec(PL_lex_encoding);
2661 if (SvOK(sv) || SvGMAGICAL(sv)) {
2662 PL_lex_encoding = newSVsv(sv);
2665 PL_lex_encoding = NULL;
2668 else { /* Use the regular global */
2669 SvREFCNT_dec(PL_encoding);
2670 if (SvOK(sv) || SvGMAGICAL(sv)) {
2671 if (PL_localizing != 2) {
2672 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED),
2673 "Setting ${^ENCODING} is deprecated");
2675 PL_encoding = newSVsv(sv);
2684 case '\006': /* ^F */
2685 PL_maxsysfd = SvIV(sv);
2687 case '\010': /* ^H */
2688 PL_hints = SvIV(sv);
2690 case '\011': /* ^I */ /* NOT \t in EBCDIC */
2691 Safefree(PL_inplace);
2692 PL_inplace = SvOK(sv) ? savesvpv(sv) : NULL;
2694 case '\016': /* ^N */
2695 if (PL_curpm && (rx = PM_GETRE(PL_curpm))
2696 && (paren = RX_LASTCLOSEPAREN(rx))) goto setparen_got_rx;
2698 case '\017': /* ^O */
2699 if (*(mg->mg_ptr+1) == '\0') {
2700 Safefree(PL_osname);
2703 TAINT_PROPER("assigning to $^O");
2704 PL_osname = savesvpv(sv);
2707 else if (strEQ(mg->mg_ptr, "\017PEN")) {
2709 const char *const start = SvPV(sv, len);
2710 const char *out = (const char*)memchr(start, '\0', len);
2714 PL_compiling.cop_hints |= HINT_LEXICAL_IO_IN | HINT_LEXICAL_IO_OUT;
2715 PL_hints |= HINT_LEXICAL_IO_IN | HINT_LEXICAL_IO_OUT;
2717 /* Opening for input is more common than opening for output, so
2718 ensure that hints for input are sooner on linked list. */
2719 tmp = out ? newSVpvn_flags(out + 1, start + len - out - 1,
2721 : newSVpvs_flags("", SvUTF8(sv));
2722 (void)hv_stores(GvHV(PL_hintgv), "open>", tmp);
2725 tmp = newSVpvn_flags(start, out ? (STRLEN)(out - start) : len,
2727 (void)hv_stores(GvHV(PL_hintgv), "open<", tmp);
2731 case '\020': /* ^P */
2732 PL_perldb = SvIV(sv);
2733 if (PL_perldb && !PL_DBsingle)
2736 case '\024': /* ^T */
2738 PL_basetime = (Time_t)(SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv));
2740 PL_basetime = (Time_t)SvIV(sv);
2743 case '\025': /* ^UTF8CACHE */
2744 if (strEQ(mg->mg_ptr+1, "TF8CACHE")) {
2745 PL_utf8cache = (signed char) sv_2iv(sv);
2748 case '\027': /* ^W & $^WARNING_BITS */
2749 if (*(mg->mg_ptr+1) == '\0') {
2750 if ( ! (PL_dowarn & G_WARN_ALL_MASK)) {
2752 PL_dowarn = (PL_dowarn & ~G_WARN_ON)
2753 | (i ? G_WARN_ON : G_WARN_OFF) ;
2756 else if (strEQ(mg->mg_ptr+1, "ARNING_BITS")) {
2757 if ( ! (PL_dowarn & G_WARN_ALL_MASK)) {
2759 PL_compiling.cop_warnings = pWARN_STD;
2764 int accumulate = 0 ;
2765 int any_fatals = 0 ;
2766 const char * const ptr = SvPV_const(sv, len) ;
2767 for (i = 0 ; i < len ; ++i) {
2768 accumulate |= ptr[i] ;
2769 any_fatals |= (ptr[i] & 0xAA) ;
2772 if (!specialWARN(PL_compiling.cop_warnings))
2773 PerlMemShared_free(PL_compiling.cop_warnings);
2774 PL_compiling.cop_warnings = pWARN_NONE;
2776 /* Yuck. I can't see how to abstract this: */
2778 ((STRLEN *)SvPV_nolen_const(sv)) - 1,
2782 if (!specialWARN(PL_compiling.cop_warnings))
2783 PerlMemShared_free(PL_compiling.cop_warnings);
2784 PL_compiling.cop_warnings = pWARN_ALL;
2785 PL_dowarn |= G_WARN_ONCE ;
2789 const char *const p = SvPV_const(sv, len);
2791 PL_compiling.cop_warnings
2792 = Perl_new_warnings_bitfield(aTHX_ PL_compiling.cop_warnings,
2795 if (isWARN_on(PL_compiling.cop_warnings, WARN_ONCE))
2796 PL_dowarn |= G_WARN_ONCE ;
2804 if (PL_localizing) {
2805 if (PL_localizing == 1)
2806 SAVESPTR(PL_last_in_gv);
2808 else if (SvOK(sv) && GvIO(PL_last_in_gv))
2809 IoLINES(GvIOp(PL_last_in_gv)) = SvIV(sv);
2812 Safefree(IoTOP_NAME(GvIOp(PL_defoutgv)));
2813 s = IoTOP_NAME(GvIOp(PL_defoutgv)) = savesvpv(sv);
2814 IoTOP_GV(GvIOp(PL_defoutgv)) = gv_fetchsv(sv, GV_ADD, SVt_PVIO);
2817 Safefree(IoFMT_NAME(GvIOp(PL_defoutgv)));
2818 s = IoFMT_NAME(GvIOp(PL_defoutgv)) = savesvpv(sv);
2819 IoFMT_GV(GvIOp(PL_defoutgv)) = gv_fetchsv(sv, GV_ADD, SVt_PVIO);
2822 IoPAGE_LEN(GvIOp(PL_defoutgv)) = (SvIV(sv));
2825 IoLINES_LEFT(GvIOp(PL_defoutgv)) = (SvIV(sv));
2826 if (IoLINES_LEFT(GvIOp(PL_defoutgv)) < 0L)
2827 IoLINES_LEFT(GvIOp(PL_defoutgv)) = 0L;
2830 IoPAGE(GvIOp(PL_defoutgv)) = (SvIV(sv));
2834 IO * const io = GvIO(PL_defoutgv);
2837 if ((SvIV(sv)) == 0)
2838 IoFLAGS(io) &= ~IOf_FLUSH;
2840 if (!(IoFLAGS(io) & IOf_FLUSH)) {
2841 PerlIO *ofp = IoOFP(io);
2843 (void)PerlIO_flush(ofp);
2844 IoFLAGS(io) |= IOf_FLUSH;
2853 SV *referent= SvRV(sv);
2854 const char *reftype= sv_reftype(referent, 0);
2855 /* XXX: dodgy type check: This leaves me feeling dirty, but the alternative
2856 * is to copy pretty much the entire sv_reftype() into this routine, or to do
2857 * a full string comparison on the return of sv_reftype() both of which
2858 * make me feel worse! NOTE, do not modify this comment without reviewing the
2859 * corresponding comment in sv_reftype(). - Yves */
2860 if (reftype[0] == 'S' || reftype[0] == 'L') {
2861 IV val= SvIV(referent);
2863 tmpsv= &PL_sv_undef;
2864 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED),
2865 "Setting $/ to a reference to %s as a form of slurp is deprecated, treating as undef",
2866 SvIV(SvRV(sv)) < 0 ? "a negative integer" : "zero"
2870 sv_setsv(sv, PL_rs);
2871 /* diag_listed_as: Setting $/ to %s reference is forbidden */
2872 Perl_croak(aTHX_ "Setting $/ to a%s %s reference is forbidden",
2873 *reftype == 'A' ? "n" : "", reftype);
2876 SvREFCNT_dec(PL_rs);
2877 PL_rs = newSVsv(tmpsv);
2881 SvREFCNT_dec(PL_ors_sv);
2883 PL_ors_sv = newSVsv(sv);
2891 Perl_croak(aTHX_ "Assigning non-zero to $[ is no longer possible");
2894 #ifdef COMPLEX_STATUS
2895 if (PL_localizing == 2) {
2896 SvUPGRADE(sv, SVt_PVLV);
2897 PL_statusvalue = LvTARGOFF(sv);
2898 PL_statusvalue_vms = LvTARGLEN(sv);
2902 #ifdef VMSISH_STATUS
2904 STATUS_NATIVE_CHILD_SET((U32)SvIV(sv));
2907 STATUS_UNIX_EXIT_SET(SvIV(sv));
2912 # define PERL_VMS_BANG vaxc$errno
2914 # define PERL_VMS_BANG 0
2916 #if defined(WIN32) && ! defined(UNDER_CE)
2917 SETERRNO(win32_get_errno(SvIOK(sv) ? SvIVX(sv) : SvOK(sv) ? sv_2iv(sv) : 0),
2918 (SvIV(sv) == EVMSERR) ? 4 : PERL_VMS_BANG);
2920 SETERRNO(SvIOK(sv) ? SvIVX(sv) : SvOK(sv) ? sv_2iv(sv) : 0,
2921 (SvIV(sv) == EVMSERR) ? 4 : PERL_VMS_BANG);
2927 /* XXX $< currently silently ignores failures */
2928 const Uid_t new_uid = SvUID(sv);
2929 PL_delaymagic_uid = new_uid;
2930 if (PL_delaymagic) {
2931 PL_delaymagic |= DM_RUID;
2932 break; /* don't do magic till later */
2935 PERL_UNUSED_RESULT(setruid(new_uid));
2938 PERL_UNUSED_RESULT(setreuid(new_uid, (Uid_t)-1));
2940 #ifdef HAS_SETRESUID
2941 PERL_UNUSED_RESULT(setresuid(new_uid, (Uid_t)-1, (Uid_t)-1));
2943 if (new_uid == PerlProc_geteuid()) { /* special case $< = $> */
2945 /* workaround for Darwin's setuid peculiarity, cf [perl #24122] */
2946 if (new_uid != 0 && PerlProc_getuid() == 0)
2947 PERL_UNUSED_RESULT(PerlProc_setuid(0));
2949 PERL_UNUSED_RESULT(PerlProc_setuid(new_uid));
2951 Perl_croak(aTHX_ "setruid() not implemented");
2960 /* XXX $> currently silently ignores failures */
2961 const Uid_t new_euid = SvUID(sv);
2962 PL_delaymagic_euid = new_euid;
2963 if (PL_delaymagic) {
2964 PL_delaymagic |= DM_EUID;
2965 break; /* don't do magic till later */
2968 PERL_UNUSED_RESULT(seteuid(new_euid));
2971 PERL_UNUSED_RESULT(setreuid((Uid_t)-1, new_euid));
2973 #ifdef HAS_SETRESUID
2974 PERL_UNUSED_RESULT(setresuid((Uid_t)-1, new_euid, (Uid_t)-1));
2976 if (new_euid == PerlProc_getuid()) /* special case $> = $< */
2977 PERL_UNUSED_RESULT(PerlProc_setuid(new_euid));
2979 Perl_croak(aTHX_ "seteuid() not implemented");
2988 /* XXX $( currently silently ignores failures */
2989 const Gid_t new_gid = SvGID(sv);
2990 PL_delaymagic_gid = new_gid;
2991 if (PL_delaymagic) {
2992 PL_delaymagic |= DM_RGID;
2993 break; /* don't do magic till later */
2996 PERL_UNUSED_RESULT(setrgid(new_gid));
2999 PERL_UNUSED_RESULT(setregid(new_gid, (Gid_t)-1));
3001 #ifdef HAS_SETRESGID
3002 PERL_UNUSED_RESULT(setresgid(new_gid, (Gid_t)-1, (Gid_t) -1));
3004 if (new_gid == PerlProc_getegid()) /* special case $( = $) */
3005 PERL_UNUSED_RESULT(PerlProc_setgid(new_gid));
3007 Perl_croak(aTHX_ "setrgid() not implemented");
3016 /* (hv) best guess: maybe we'll need configure probes to do a better job,
3017 * but you can override it if you need to.
3020 #define INVALID_GID ((Gid_t)-1)
3022 /* XXX $) currently silently ignores failures */
3024 #ifdef HAS_SETGROUPS
3026 const char *p = SvPV_const(sv, len);
3027 Groups_t *gary = NULL;
3030 #ifdef _SC_NGROUPS_MAX
3031 int maxgrp = sysconf(_SC_NGROUPS_MAX);
3036 int maxgrp = NGROUPS;
3041 if (grok_atoUV(p, &uv, &endptr))
3042 new_egid = (Gid_t)uv;
3044 new_egid = INVALID_GID;
3047 for (i = 0; i < maxgrp; ++i) {
3056 Newx(gary, i + 1, Groups_t);
3058 Renew(gary, i + 1, Groups_t);
3059 if (grok_atoUV(p, &uv, &endptr))
3060 gary[i] = (Groups_t)uv;
3062 gary[i] = INVALID_GID;
3067 PERL_UNUSED_RESULT(setgroups(i, gary));
3070 #else /* HAS_SETGROUPS */
3071 new_egid = SvGID(sv);
3072 #endif /* HAS_SETGROUPS */
3073 PL_delaymagic_egid = new_egid;
3074 if (PL_delaymagic) {
3075 PL_delaymagic |= DM_EGID;
3076 break; /* don't do magic till later */
3079 PERL_UNUSED_RESULT(setegid(new_egid));
3082 PERL_UNUSED_RESULT(setregid((Gid_t)-1, new_egid));
3084 #ifdef HAS_SETRESGID
3085 PERL_UNUSED_RESULT(setresgid((Gid_t)-1, new_egid, (Gid_t)-1));
3087 if (new_egid == PerlProc_getgid()) /* special case $) = $( */
3088 PERL_UNUSED_RESULT(PerlProc_setgid(new_egid));
3090 Perl_croak(aTHX_ "setegid() not implemented");
3098 PL_chopset = SvPV_force(sv,len);
3101 /* Store the pid in mg->mg_obj so we can tell when a fork has
3102 occurred. mg->mg_obj points to *$ by default, so clear it. */
3103 if (isGV(mg->mg_obj)) {
3104 if (mg->mg_flags & MGf_REFCOUNTED) /* probably never true */
3105 SvREFCNT_dec(mg->mg_obj);
3106 mg->mg_flags |= MGf_REFCOUNTED;
3107 mg->mg_obj = newSViv((IV)PerlProc_getpid());
3109 else sv_setiv(mg->mg_obj, (IV)PerlProc_getpid());
3112 LOCK_DOLLARZERO_MUTEX;
3113 #ifdef HAS_SETPROCTITLE
3114 /* The BSDs don't show the argv[] in ps(1) output, they
3115 * show a string from the process struct and provide
3116 * the setproctitle() routine to manipulate that. */
3117 if (PL_origalen != 1) {
3118 s = SvPV_const(sv, len);
3119 # if __FreeBSD_version > 410001
3120 /* The leading "-" removes the "perl: " prefix,
3121 * but not the "(perl) suffix from the ps(1)
3122 * output, because that's what ps(1) shows if the
3123 * argv[] is modified. */
3124 setproctitle("-%s", s);
3125 # else /* old FreeBSDs, NetBSD, OpenBSD, anyBSD */
3126 /* This doesn't really work if you assume that
3127 * $0 = 'foobar'; will wipe out 'perl' from the $0
3128 * because in ps(1) output the result will be like
3129 * sprintf("perl: %s (perl)", s)
3130 * I guess this is a security feature:
3131 * one (a user process) cannot get rid of the original name.
3133 setproctitle("%s", s);
3136 #elif defined(__hpux) && defined(PSTAT_SETCMD)
3137 if (PL_origalen != 1) {
3139 s = SvPV_const(sv, len);
3140 un.pst_command = (char *)s;
3141 pstat(PSTAT_SETCMD, un, len, 0, 0);
3144 if (PL_origalen > 1) {
3145 /* PL_origalen is set in perl_parse(). */
3146 s = SvPV_force(sv,len);
3147 if (len >= (STRLEN)PL_origalen-1) {
3148 /* Longer than original, will be truncated. We assume that
3149 * PL_origalen bytes are available. */
3150 Copy(s, PL_origargv[0], PL_origalen-1, char);
3153 /* Shorter than original, will be padded. */
3155 /* Special case for Mac OS X: see [perl #38868] */
3158 /* Is the space counterintuitive? Yes.
3159 * (You were expecting \0?)
3160 * Does it work? Seems to. (In Linux 2.4.20 at least.)
3162 const int pad = ' ';
3164 Copy(s, PL_origargv[0], len, char);
3165 PL_origargv[0][len] = 0;
3166 memset(PL_origargv[0] + len + 1,
3167 pad, PL_origalen - len - 1);
3169 PL_origargv[0][PL_origalen-1] = 0;
3170 for (i = 1; i < PL_origargc; i++)
3172 #ifdef HAS_PRCTL_SET_NAME
3173 /* Set the legacy process name in addition to the POSIX name on Linux */
3174 if (prctl(PR_SET_NAME, (unsigned long)s, 0, 0, 0) != 0) {
3175 /* diag_listed_as: SKIPME */
3176 Perl_croak(aTHX_ "Can't set $0 with prctl(): %s", Strerror(errno));
3181 UNLOCK_DOLLARZERO_MUTEX;
3188 Perl_whichsig_sv(pTHX_ SV *sigsv)
3192 PERL_ARGS_ASSERT_WHICHSIG_SV;
3193 sigpv = SvPV_const(sigsv, siglen);
3194 return whichsig_pvn(sigpv, siglen);
3198 Perl_whichsig_pv(pTHX_ const char *sig)
3200 PERL_ARGS_ASSERT_WHICHSIG_PV;
3201 return whichsig_pvn(sig, strlen(sig));
3205 Perl_whichsig_pvn(pTHX_ const char *sig, STRLEN len)
3209 PERL_ARGS_ASSERT_WHICHSIG_PVN;
3210 PERL_UNUSED_CONTEXT;
3212 for (sigv = (char* const*)PL_sig_name; *sigv; sigv++)
3213 if (strlen(*sigv) == len && memEQ(sig,*sigv, len))
3214 return PL_sig_num[sigv - (char* const*)PL_sig_name];
3216 if (memEQs(sig, len, "CHLD"))
3220 if (memEQs(sig, len, "CLD"))
3227 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
3228 Perl_sighandler(int sig, siginfo_t *sip, void *uap)
3230 Perl_sighandler(int sig)
3233 #ifdef PERL_GET_SIG_CONTEXT
3234 dTHXa(PERL_GET_SIG_CONTEXT);
3241 SV * const tSv = PL_Sv;
3245 XPV * const tXpv = PL_Xpv;
3246 I32 old_ss_ix = PL_savestack_ix;
3247 SV *errsv_save = NULL;
3250 if (!PL_psig_ptr[sig]) {
3251 PerlIO_printf(Perl_error_log, "Signal SIG%s received, but no signal handler set.\n",
3256 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG) {
3257 /* Max number of items pushed there is 3*n or 4. We cannot fix
3258 infinity, so we fix 4 (in fact 5): */
3259 if (PL_savestack_ix + 15 <= PL_savestack_max) {
3261 PL_savestack_ix += 5; /* Protect save in progress. */
3262 SAVEDESTRUCTOR_X(S_unwind_handler_stack, NULL);
3265 /* sv_2cv is too complicated, try a simpler variant first: */
3266 if (!SvROK(PL_psig_ptr[sig]) || !(cv = MUTABLE_CV(SvRV(PL_psig_ptr[sig])))
3267 || SvTYPE(cv) != SVt_PVCV) {
3269 cv = sv_2cv(PL_psig_ptr[sig], &st, &gv, GV_ADD);
3272 if (!cv || !CvROOT(cv)) {
3273 const HEK * const hek = gv
3277 : cv && CvGV(cv) ? GvENAME_HEK(CvGV(cv)) : NULL;
3279 Perl_ck_warner(aTHX_ packWARN(WARN_SIGNAL),
3280 "SIG%s handler \"%"HEKf"\" not defined.\n",
3281 PL_sig_name[sig], hek);
3282 /* diag_listed_as: SIG%s handler "%s" not defined */
3283 else Perl_ck_warner(aTHX_ packWARN(WARN_SIGNAL),
3284 "SIG%s handler \"__ANON__\" not defined.\n",
3289 sv = PL_psig_name[sig]
3290 ? SvREFCNT_inc_NN(PL_psig_name[sig])
3291 : newSVpv(PL_sig_name[sig],0);
3295 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG) {
3296 /* make sure our assumption about the size of the SAVEs are correct:
3297 * 3 for SAVEDESTRUCTOR_X, 2 for SAVEFREESV */
3298 assert(old_ss_ix + 2 + ((flags & 1) ? 3+5 : 0) == PL_savestack_ix);
3301 PUSHSTACKi(PERLSI_SIGNAL);
3304 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
3306 struct sigaction oact;
3308 if (sigaction(sig, 0, &oact) == 0 && oact.sa_flags & SA_SIGINFO) {
3311 SV *rv = newRV_noinc(MUTABLE_SV(sih));
3312 /* The siginfo fields signo, code, errno, pid, uid,
3313 * addr, status, and band are defined by POSIX/SUSv3. */
3314 (void)hv_stores(sih, "signo", newSViv(sip->si_signo));
3315 (void)hv_stores(sih, "code", newSViv(sip->si_code));
3316 #if 0 /* XXX TODO: Configure scan for the existence of these, but even that does not help if the SA_SIGINFO is not implemented according to the spec. */
3317 hv_stores(sih, "errno", newSViv(sip->si_errno));
3318 hv_stores(sih, "status", newSViv(sip->si_status));
3319 hv_stores(sih, "uid", newSViv(sip->si_uid));
3320 hv_stores(sih, "pid", newSViv(sip->si_pid));
3321 hv_stores(sih, "addr", newSVuv(PTR2UV(sip->si_addr)));
3322 hv_stores(sih, "band", newSViv(sip->si_band));
3326 mPUSHp((char *)sip, sizeof(*sip));
3334 errsv_save = newSVsv(ERRSV);
3336 call_sv(MUTABLE_SV(cv), G_DISCARD|G_EVAL);
3340 SV * const errsv = ERRSV;
3341 if (SvTRUE_NN(errsv)) {
3342 SvREFCNT_dec(errsv_save);
3344 /* Handler "died", for example to get out of a restart-able read().
3345 * Before we re-do that on its behalf re-enable the signal which was
3346 * blocked by the system when we entered.
3348 #ifdef HAS_SIGPROCMASK
3349 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
3355 sigaddset(&set,sig);
3356 sigprocmask(SIG_UNBLOCK, &set, NULL);
3359 /* Not clear if this will work */
3360 (void)rsignal(sig, SIG_IGN);
3361 (void)rsignal(sig, PL_csighandlerp);
3363 #endif /* !PERL_MICRO */
3367 sv_setsv(errsv, errsv_save);
3368 SvREFCNT_dec(errsv_save);
3373 /* pop any of SAVEFREESV, SAVEDESTRUCTOR_X and "save in progress" */
3374 PL_savestack_ix = old_ss_ix;
3376 SvREFCNT_dec_NN(sv);
3377 PL_op = myop; /* Apparently not needed... */
3379 PL_Sv = tSv; /* Restore global temporaries. */
3386 S_restore_magic(pTHX_ const void *p)
3388 MGS* const mgs = SSPTR(PTR2IV(p), MGS*);
3389 SV* const sv = mgs->mgs_sv;
3395 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3396 SvTEMP_off(sv); /* if it's still magical, this value isn't temporary */
3397 #ifdef PERL_OLD_COPY_ON_WRITE
3398 /* While magic was saved (and off) sv_setsv may well have seen
3399 this SV as a prime candidate for COW. */
3401 sv_force_normal_flags(sv, 0);
3404 SvFLAGS(sv) |= mgs->mgs_flags;
3409 bumped = mgs->mgs_bumped;
3410 mgs->mgs_sv = NULL; /* mark the MGS structure as restored */
3412 /* If we're still on top of the stack, pop us off. (That condition
3413 * will be satisfied if restore_magic was called explicitly, but *not*
3414 * if it's being called via leave_scope.)
3415 * The reason for doing this is that otherwise, things like sv_2cv()
3416 * may leave alloc gunk on the savestack, and some code
3417 * (e.g. sighandler) doesn't expect that...
3419 if (PL_savestack_ix == mgs->mgs_ss_ix)
3421 UV popval = SSPOPUV;
3422 assert(popval == SAVEt_DESTRUCTOR_X);
3423 PL_savestack_ix -= 2;
3425 assert((popval & SAVE_MASK) == SAVEt_ALLOC);
3426 PL_savestack_ix -= popval >> SAVE_TIGHT_SHIFT;
3429 if (SvREFCNT(sv) == 1) {
3430 /* We hold the last reference to this SV, which implies that the
3431 SV was deleted as a side effect of the routines we called.
3432 So artificially keep it alive a bit longer.
3433 We avoid turning on the TEMP flag, which can cause the SV's
3434 buffer to get stolen (and maybe other stuff). */
3439 SvREFCNT_dec_NN(sv); /* undo the inc in S_save_magic() */
3443 /* clean up the mess created by Perl_sighandler().
3444 * Note that this is only called during an exit in a signal handler;
3445 * a die is trapped by the call_sv() and the SAVEDESTRUCTOR_X manually
3449 S_unwind_handler_stack(pTHX_ const void *p)
3453 PL_savestack_ix -= 5; /* Unprotect save in progress. */
3457 =for apidoc magic_sethint
3459 Triggered by a store to %^H, records the key/value pair to
3460 C<PL_compiling.cop_hints_hash>. It is assumed that hints aren't storing
3461 anything that would need a deep copy. Maybe we should warn if we find a
3467 Perl_magic_sethint(pTHX_ SV *sv, MAGIC *mg)
3469 SV *key = (mg->mg_len == HEf_SVKEY) ? MUTABLE_SV(mg->mg_ptr)
3470 : newSVpvn_flags(mg->mg_ptr, mg->mg_len, SVs_TEMP);
3472 PERL_ARGS_ASSERT_MAGIC_SETHINT;
3474 /* mg->mg_obj isn't being used. If needed, it would be possible to store
3475 an alternative leaf in there, with PL_compiling.cop_hints being used if
3476 it's NULL. If needed for threads, the alternative could lock a mutex,
3477 or take other more complex action. */
3479 /* Something changed in %^H, so it will need to be restored on scope exit.
3480 Doing this here saves a lot of doing it manually in perl code (and
3481 forgetting to do it, and consequent subtle errors. */
3482 PL_hints |= HINT_LOCALIZE_HH;
3483 CopHINTHASH_set(&PL_compiling,
3484 cophh_store_sv(CopHINTHASH_get(&PL_compiling), key, 0, sv, 0));
3489 =for apidoc magic_clearhint
3491 Triggered by a delete from %^H, records the key to
3492 C<PL_compiling.cop_hints_hash>.
3497 Perl_magic_clearhint(pTHX_ SV *sv, MAGIC *mg)
3499 PERL_ARGS_ASSERT_MAGIC_CLEARHINT;
3500 PERL_UNUSED_ARG(sv);
3502 PL_hints |= HINT_LOCALIZE_HH;
3503 CopHINTHASH_set(&PL_compiling,
3504 mg->mg_len == HEf_SVKEY
3505 ? cophh_delete_sv(CopHINTHASH_get(&PL_compiling),
3506 MUTABLE_SV(mg->mg_ptr), 0, 0)
3507 : cophh_delete_pvn(CopHINTHASH_get(&PL_compiling),
3508 mg->mg_ptr, mg->mg_len, 0, 0));
3513 =for apidoc magic_clearhints
3515 Triggered by clearing %^H, resets C<PL_compiling.cop_hints_hash>.
3520 Perl_magic_clearhints(pTHX_ SV *sv, MAGIC *mg)
3522 PERL_ARGS_ASSERT_MAGIC_CLEARHINTS;
3523 PERL_UNUSED_ARG(sv);
3524 PERL_UNUSED_ARG(mg);
3525 cophh_free(CopHINTHASH_get(&PL_compiling));
3526 CopHINTHASH_set(&PL_compiling, cophh_new_empty());
3531 Perl_magic_copycallchecker(pTHX_ SV *sv, MAGIC *mg, SV *nsv,
3532 const char *name, I32 namlen)
3536 PERL_ARGS_ASSERT_MAGIC_COPYCALLCHECKER;
3537 PERL_UNUSED_ARG(sv);
3538 PERL_UNUSED_ARG(name);
3539 PERL_UNUSED_ARG(namlen);
3541 sv_magic(nsv, &PL_sv_undef, mg->mg_type, NULL, 0);
3542 nmg = mg_find(nsv, mg->mg_type);
3544 if (nmg->mg_flags & MGf_REFCOUNTED) SvREFCNT_dec(nmg->mg_obj);
3545 nmg->mg_ptr = mg->mg_ptr;
3546 nmg->mg_obj = SvREFCNT_inc_simple(mg->mg_obj);
3547 nmg->mg_flags |= MGf_REFCOUNTED;
3552 Perl_magic_setdebugvar(pTHX_ SV *sv, MAGIC *mg) {
3553 PERL_ARGS_ASSERT_MAGIC_SETDEBUGVAR;
3555 #if DBVARMG_SINGLE != 0
3556 assert(mg->mg_private >= DBVARMG_SINGLE);
3558 assert(mg->mg_private < DBVARMG_COUNT);
3560 PL_DBcontrol[mg->mg_private] = SvIV_nomg(sv);
3566 Perl_magic_getdebugvar(pTHX_ SV *sv, MAGIC *mg) {
3567 PERL_ARGS_ASSERT_MAGIC_GETDEBUGVAR;
3569 #if DBVARMG_SINGLE != 0
3570 assert(mg->mg_private >= DBVARMG_SINGLE);
3572 assert(mg->mg_private < DBVARMG_COUNT);
3573 sv_setiv(sv, PL_DBcontrol[mg->mg_private]);
3580 * c-indentation-style: bsd
3582 * indent-tabs-mode: nil
3585 * ex: set ts=8 sts=4 sw=4 et: