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<L</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 >= C<SVt_PVMG>. See C<L</sv_magic>>.
169 Perl_mg_get(pTHX_ SV *sv)
171 const I32 mgs_ix = SSNEW(sizeof(MGS));
174 bool taint_only = TRUE; /* the only get method seen is taint */
175 MAGIC *newmg, *head, *cur, *mg;
177 PERL_ARGS_ASSERT_MG_GET;
179 if (PL_localizing == 1 && sv == DEFSV) return 0;
181 /* We must call svt_get(sv, mg) for each valid entry in the linked
182 list of magic. svt_get() may delete the current entry, add new
183 magic to the head of the list, or upgrade the SV. AMS 20010810 */
185 newmg = cur = head = mg = SvMAGIC(sv);
187 const MGVTBL * const vtbl = mg->mg_virtual;
188 MAGIC * const nextmg = mg->mg_moremagic; /* it may delete itself */
190 if (!(mg->mg_flags & MGf_GSKIP) && vtbl && vtbl->svt_get) {
192 /* taint's mg get is so dumb it doesn't need flag saving */
193 if (mg->mg_type != PERL_MAGIC_taint) {
196 save_magic(mgs_ix, sv);
201 vtbl->svt_get(aTHX_ sv, mg);
203 /* guard against magic having been deleted - eg FETCH calling
206 /* recalculate flags */
207 (SSPTR(mgs_ix, MGS *))->mgs_flags &= ~(SVs_GMG|SVs_SMG|SVs_RMG);
211 /* recalculate flags if this entry was deleted. */
212 if (mg->mg_flags & MGf_GSKIP)
213 (SSPTR(mgs_ix, MGS *))->mgs_flags &=
214 ~(SVs_GMG|SVs_SMG|SVs_RMG);
216 else if (vtbl == &PL_vtbl_utf8) {
217 /* get-magic can reallocate the PV, unless there's only taint
221 for (mg2 = nextmg; mg2; mg2 = mg2->mg_moremagic) {
222 if ( mg2->mg_type != PERL_MAGIC_taint
223 && !(mg2->mg_flags & MGf_GSKIP)
225 && mg2->mg_virtual->svt_get
233 magic_setutf8(sv, mg);
239 /* Have we finished with the new entries we saw? Start again
240 where we left off (unless there are more new entries). */
248 /* Were any new entries added? */
249 if (!have_new && (newmg = SvMAGIC(sv)) != head) {
253 /* recalculate flags */
254 (SSPTR(mgs_ix, MGS *))->mgs_flags &= ~(SVs_GMG|SVs_SMG|SVs_RMG);
259 restore_magic(INT2PTR(void *, (IV)mgs_ix));
267 Do magic after a value is assigned to the SV. See C<L</sv_magic>>.
273 Perl_mg_set(pTHX_ SV *sv)
275 const I32 mgs_ix = SSNEW(sizeof(MGS));
279 PERL_ARGS_ASSERT_MG_SET;
281 if (PL_localizing == 2 && sv == DEFSV) return 0;
283 save_magic_flags(mgs_ix, sv, SVs_GMG|SVs_SMG); /* leave SVs_RMG on */
285 for (mg = SvMAGIC(sv); mg; mg = nextmg) {
286 const MGVTBL* vtbl = mg->mg_virtual;
287 nextmg = mg->mg_moremagic; /* it may delete itself */
288 if (mg->mg_flags & MGf_GSKIP) {
289 mg->mg_flags &= ~MGf_GSKIP; /* setting requires another read */
290 (SSPTR(mgs_ix, MGS*))->mgs_flags &= ~(SVs_GMG|SVs_SMG|SVs_RMG);
292 if (PL_localizing == 2
293 && PERL_MAGIC_TYPE_IS_VALUE_MAGIC(mg->mg_type))
295 if (vtbl && vtbl->svt_set)
296 vtbl->svt_set(aTHX_ sv, mg);
299 restore_magic(INT2PTR(void*, (IV)mgs_ix));
304 =for apidoc mg_length
306 Reports on the SV's length in bytes, calling length magic if available,
307 but does not set the UTF8 flag on C<sv>. It will fall back to 'get'
308 magic if there is no 'length' magic, but with no indication as to
309 whether it called 'get' magic. It assumes C<sv> is a C<PVMG> or
310 higher. Use C<sv_len()> instead.
316 Perl_mg_length(pTHX_ SV *sv)
321 PERL_ARGS_ASSERT_MG_LENGTH;
323 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
324 const MGVTBL * const vtbl = mg->mg_virtual;
325 if (vtbl && vtbl->svt_len) {
326 const I32 mgs_ix = SSNEW(sizeof(MGS));
327 save_magic(mgs_ix, sv);
328 /* omit MGf_GSKIP -- not changed here */
329 len = vtbl->svt_len(aTHX_ sv, mg);
330 restore_magic(INT2PTR(void*, (IV)mgs_ix));
335 (void)SvPV_const(sv, len);
340 Perl_mg_size(pTHX_ SV *sv)
344 PERL_ARGS_ASSERT_MG_SIZE;
346 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
347 const MGVTBL* const vtbl = mg->mg_virtual;
348 if (vtbl && vtbl->svt_len) {
349 const I32 mgs_ix = SSNEW(sizeof(MGS));
351 save_magic(mgs_ix, sv);
352 /* omit MGf_GSKIP -- not changed here */
353 len = vtbl->svt_len(aTHX_ sv, mg);
354 restore_magic(INT2PTR(void*, (IV)mgs_ix));
361 return AvFILLp((const AV *) sv); /* Fallback to non-tied array */
365 Perl_croak(aTHX_ "Size magic not implemented");
368 NOT_REACHED; /* NOTREACHED */
374 Clear something magical that the SV represents. See C<L</sv_magic>>.
380 Perl_mg_clear(pTHX_ SV *sv)
382 const I32 mgs_ix = SSNEW(sizeof(MGS));
386 PERL_ARGS_ASSERT_MG_CLEAR;
388 save_magic(mgs_ix, sv);
390 for (mg = SvMAGIC(sv); mg; mg = nextmg) {
391 const MGVTBL* const vtbl = mg->mg_virtual;
392 /* omit GSKIP -- never set here */
394 nextmg = mg->mg_moremagic; /* it may delete itself */
396 if (vtbl && vtbl->svt_clear)
397 vtbl->svt_clear(aTHX_ sv, mg);
400 restore_magic(INT2PTR(void*, (IV)mgs_ix));
405 S_mg_findext_flags(const SV *sv, int type, const MGVTBL *vtbl, U32 flags)
412 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
413 if (mg->mg_type == type && (!flags || mg->mg_virtual == vtbl)) {
425 Finds the magic pointer for C<type> matching the SV. See C<L</sv_magic>>.
431 Perl_mg_find(const SV *sv, int type)
433 return S_mg_findext_flags(sv, type, NULL, 0);
437 =for apidoc mg_findext
439 Finds the magic pointer of C<type> with the given C<vtbl> for the C<SV>. See
446 Perl_mg_findext(const SV *sv, int type, const MGVTBL *vtbl)
448 return S_mg_findext_flags(sv, type, vtbl, 1);
452 Perl_mg_find_mglob(pTHX_ SV *sv)
454 PERL_ARGS_ASSERT_MG_FIND_MGLOB;
455 if (SvTYPE(sv) == SVt_PVLV && LvTYPE(sv) == 'y') {
456 /* This sv is only a delegate. //g magic must be attached to
461 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv))
462 return S_mg_findext_flags(sv, PERL_MAGIC_regex_global, 0, 0);
469 Copies the magic from one SV to another. See C<L</sv_magic>>.
475 Perl_mg_copy(pTHX_ SV *sv, SV *nsv, const char *key, I32 klen)
480 PERL_ARGS_ASSERT_MG_COPY;
482 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
483 const MGVTBL* const vtbl = mg->mg_virtual;
484 if ((mg->mg_flags & MGf_COPY) && vtbl->svt_copy){
485 count += vtbl->svt_copy(aTHX_ sv, mg, nsv, key, klen);
488 const char type = mg->mg_type;
489 if (isUPPER(type) && type != PERL_MAGIC_uvar) {
491 (type == PERL_MAGIC_tied)
494 toLOWER(type), key, klen);
503 =for apidoc mg_localize
505 Copy some of the magic from an existing SV to new localized version of that
506 SV. Container magic (I<e.g.>, C<%ENV>, C<$1>, C<tie>)
507 gets copied, value magic doesn't (I<e.g.>,
510 If C<setmagic> is false then no set magic will be called on the new (empty) SV.
511 This typically means that assignment will soon follow (e.g. S<C<'local $x = $y'>>),
512 and that will handle the magic.
518 Perl_mg_localize(pTHX_ SV *sv, SV *nsv, bool setmagic)
522 PERL_ARGS_ASSERT_MG_LOCALIZE;
527 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
528 const MGVTBL* const vtbl = mg->mg_virtual;
529 if (PERL_MAGIC_TYPE_IS_VALUE_MAGIC(mg->mg_type))
532 if ((mg->mg_flags & MGf_LOCAL) && vtbl->svt_local)
533 (void)vtbl->svt_local(aTHX_ nsv, mg);
535 sv_magicext(nsv, mg->mg_obj, mg->mg_type, vtbl,
536 mg->mg_ptr, mg->mg_len);
538 /* container types should remain read-only across localization */
539 SvFLAGS(nsv) |= SvREADONLY(sv);
542 if (SvTYPE(nsv) >= SVt_PVMG && SvMAGIC(nsv)) {
543 SvFLAGS(nsv) |= SvMAGICAL(sv);
552 #define mg_free_struct(sv, mg) S_mg_free_struct(aTHX_ sv, mg)
554 S_mg_free_struct(pTHX_ SV *sv, MAGIC *mg)
556 const MGVTBL* const vtbl = mg->mg_virtual;
557 if (vtbl && vtbl->svt_free)
558 vtbl->svt_free(aTHX_ sv, mg);
559 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
560 if (mg->mg_len > 0 || mg->mg_type == PERL_MAGIC_utf8)
561 Safefree(mg->mg_ptr);
562 else if (mg->mg_len == HEf_SVKEY)
563 SvREFCNT_dec(MUTABLE_SV(mg->mg_ptr));
565 if (mg->mg_flags & MGf_REFCOUNTED)
566 SvREFCNT_dec(mg->mg_obj);
573 Free any magic storage used by the SV. See C<L</sv_magic>>.
579 Perl_mg_free(pTHX_ SV *sv)
584 PERL_ARGS_ASSERT_MG_FREE;
586 for (mg = SvMAGIC(sv); mg; mg = moremagic) {
587 moremagic = mg->mg_moremagic;
588 mg_free_struct(sv, mg);
589 SvMAGIC_set(sv, moremagic);
591 SvMAGIC_set(sv, NULL);
597 =for apidoc Am|void|mg_free_type|SV *sv|int how
599 Remove any magic of type C<how> from the SV C<sv>. See L</sv_magic>.
605 Perl_mg_free_type(pTHX_ SV *sv, int how)
607 MAGIC *mg, *prevmg, *moremg;
608 PERL_ARGS_ASSERT_MG_FREE_TYPE;
609 for (prevmg = NULL, mg = SvMAGIC(sv); mg; prevmg = mg, mg = moremg) {
610 moremg = mg->mg_moremagic;
611 if (mg->mg_type == how) {
613 /* temporarily move to the head of the magic chain, in case
614 custom free code relies on this historical aspect of mg_free */
616 prevmg->mg_moremagic = moremg;
617 mg->mg_moremagic = SvMAGIC(sv);
620 newhead = mg->mg_moremagic;
621 mg_free_struct(sv, mg);
622 SvMAGIC_set(sv, newhead);
632 Perl_magic_regdata_cnt(pTHX_ SV *sv, MAGIC *mg)
636 PERL_ARGS_ASSERT_MAGIC_REGDATA_CNT;
639 REGEXP * const rx = PM_GETRE(PL_curpm);
641 const SSize_t n = (SSize_t)mg->mg_obj;
642 if (n == '+') { /* @+ */
643 /* return the number possible */
644 return RX_NPARENS(rx);
645 } else { /* @- @^CAPTURE @{^CAPTURE} */
646 I32 paren = RX_LASTPAREN(rx);
648 /* return the last filled */
650 && (RX_OFFS(rx)[paren].start == -1
651 || RX_OFFS(rx)[paren].end == -1) )
657 /* @^CAPTURE @{^CAPTURE} */
658 return paren >= 0 ? (U32)(paren-1) : (U32)-1;
670 Perl_magic_regdatum_get(pTHX_ SV *sv, MAGIC *mg)
672 PERL_ARGS_ASSERT_MAGIC_REGDATUM_GET;
675 REGEXP * const rx = PM_GETRE(PL_curpm);
677 const SSize_t n = (SSize_t)mg->mg_obj;
678 /* @{^CAPTURE} does not contain $&, so we need to increment by 1 */
679 const I32 paren = mg->mg_len
680 + (n == '\003' ? 1 : 0);
685 if (paren <= (I32)RX_NPARENS(rx) &&
686 (s = RX_OFFS(rx)[paren].start) != -1 &&
687 (t = RX_OFFS(rx)[paren].end) != -1)
691 if (n == '+') /* @+ */
693 else if (n == '-') /* @- */
695 else { /* @^CAPTURE @{^CAPTURE} */
696 CALLREG_NUMBUF_FETCH(rx,paren,sv);
700 if (RX_MATCH_UTF8(rx)) {
701 const char * const b = RX_SUBBEG(rx);
703 i = RX_SUBCOFFSET(rx) +
705 (U8*)(b-RX_SUBOFFSET(rx)+i));
720 Perl_magic_regdatum_set(pTHX_ SV *sv, MAGIC *mg)
722 PERL_ARGS_ASSERT_MAGIC_REGDATUM_SET;
726 Perl_croak_no_modify();
727 NORETURN_FUNCTION_END;
730 #define SvRTRIM(sv) STMT_START { \
732 STRLEN len = SvCUR(sv); \
733 char * const p = SvPVX(sv); \
734 while (len > 0 && isSPACE(p[len-1])) \
736 SvCUR_set(sv, len); \
742 Perl_emulate_cop_io(pTHX_ const COP *const c, SV *const sv)
744 PERL_ARGS_ASSERT_EMULATE_COP_IO;
746 if (!(CopHINTS_get(c) & (HINT_LEXICAL_IO_IN|HINT_LEXICAL_IO_OUT)))
751 if ((CopHINTS_get(c) & HINT_LEXICAL_IO_IN)) {
752 SV *const value = cop_hints_fetch_pvs(c, "open<", 0);
757 if ((CopHINTS_get(c) & HINT_LEXICAL_IO_OUT)) {
758 SV *const value = cop_hints_fetch_pvs(c, "open>", 0);
766 S_fixup_errno_string(pTHX_ SV* sv)
768 /* Do what is necessary to fixup the non-empty string in 'sv' for return to
771 PERL_ARGS_ASSERT_FIXUP_ERRNO_STRING;
775 if(strEQ(SvPVX(sv), "")) {
776 sv_catpv(sv, UNKNOWN_ERRNO_MSG);
780 /* In some locales the error string may come back as UTF-8, in which
781 * case we should turn on that flag. This didn't use to happen, and to
782 * avoid as many possible backward compatibility issues as possible, we
783 * don't turn on the flag unless we have to. So the flag stays off for
784 * an entirely invariant string. We assume that if the string looks
785 * like UTF-8, it really is UTF-8: "text in any other encoding that
786 * uses bytes with the high bit set is extremely unlikely to pass a
787 * UTF-8 validity test"
788 * (http://en.wikipedia.org/wiki/Charset_detection). There is a
789 * potential that we will get it wrong however, especially on short
790 * error message text. (If it turns out to be necessary, we could also
791 * keep track if the current LC_MESSAGES locale is UTF-8) */
792 if (! IN_BYTES /* respect 'use bytes' */
793 && ! is_utf8_invariant_string((U8*) SvPVX_const(sv), SvCUR(sv))
794 && is_utf8_string((U8*) SvPVX_const(sv), SvCUR(sv)))
807 Perl_magic_get(pTHX_ SV *sv, MAGIC *mg)
810 const char *s = NULL;
812 const char * const remaining = mg->mg_ptr + 1;
815 PERL_ARGS_ASSERT_MAGIC_GET;
819 if (PL_curpm && (rx = PM_GETRE(PL_curpm))) {
821 CALLREG_NUMBUF_FETCH(rx,paren,sv);
828 nextchar = *remaining;
829 switch (*mg->mg_ptr) {
830 case '\001': /* ^A */
831 if (SvOK(PL_bodytarget)) sv_copypv(sv, PL_bodytarget);
834 if (SvTAINTED(PL_bodytarget))
837 case '\003': /* ^C, ^CHILD_ERROR_NATIVE */
838 if (nextchar == '\0') {
839 sv_setiv(sv, (IV)PL_minus_c);
841 else if (strEQ(remaining, "HILD_ERROR_NATIVE")) {
842 sv_setiv(sv, (IV)STATUS_NATIVE);
846 case '\004': /* ^D */
847 sv_setiv(sv, (IV)(PL_debug & DEBUG_MASK));
849 case '\005': /* ^E */
850 if (nextchar != '\0') {
851 if (strEQ(remaining, "NCODING"))
856 #if defined(VMS) || defined(OS2) || defined(WIN32)
860 $DESCRIPTOR(msgdsc,msg);
861 sv_setnv(sv,(NV) vaxc$errno);
862 if (sys$getmsg(vaxc$errno,&msgdsc.dsc$w_length,&msgdsc,0,0) & 1)
863 sv_setpvn(sv,msgdsc.dsc$a_pointer,msgdsc.dsc$w_length);
868 if (!(_emx_env & 0x200)) { /* Under DOS */
869 sv_setnv(sv, (NV)errno);
870 sv_setpv(sv, errno ? my_strerror(errno) : "");
872 if (errno != errno_isOS2) {
873 const int tmp = _syserrno();
874 if (tmp) /* 2nd call to _syserrno() makes it 0 */
877 sv_setnv(sv, (NV)Perl_rc);
878 sv_setpv(sv, os2error(Perl_rc));
880 if (SvOK(sv) && strNE(SvPVX(sv), "")) {
881 fixup_errno_string(sv);
883 # elif defined(WIN32)
885 const DWORD dwErr = GetLastError();
886 sv_setnv(sv, (NV)dwErr);
888 PerlProc_GetOSError(sv, dwErr);
889 fixup_errno_string(sv);
896 # error Missing code for platform
899 SvNOK_on(sv); /* what a wonderful hack! */
901 #endif /* End of platforms with special handling for $^E; others just fall
908 sv_setnv(sv, (NV)((errno == EVMSERR) ? vaxc$errno : errno));
910 sv_setnv(sv, (NV)errno);
913 if (errno == errno_isOS2 || errno == errno_isOS2_set)
914 sv_setpv(sv, os2error(Perl_rc));
922 /* Strerror can return NULL on some platforms, which will
923 * result in 'sv' not being considered SvOK. The SvNOK_on()
924 * below will cause just the number part to be valid */
925 sv_setpv(sv, my_strerror(errno));
927 fixup_errno_string(sv);
934 SvNOK_on(sv); /* what a wonderful hack! */
937 case '\006': /* ^F */
938 sv_setiv(sv, (IV)PL_maxsysfd);
940 case '\007': /* ^GLOBAL_PHASE */
941 if (strEQ(remaining, "LOBAL_PHASE")) {
942 sv_setpvn(sv, PL_phase_names[PL_phase],
943 strlen(PL_phase_names[PL_phase]));
946 case '\010': /* ^H */
947 sv_setuv(sv, PL_hints);
949 case '\011': /* ^I */ /* NOT \t in EBCDIC */
950 sv_setpv(sv, PL_inplace); /* Will undefine sv if PL_inplace is NULL */
952 case '\014': /* ^LAST_FH */
953 if (strEQ(remaining, "AST_FH")) {
955 assert(isGV_with_GP(PL_last_in_gv));
956 SV_CHECK_THINKFIRST_COW_DROP(sv);
957 prepare_SV_for_RV(sv);
959 SvRV_set(sv, SvREFCNT_inc_simple_NN(PL_last_in_gv));
963 else sv_setsv_nomg(sv, NULL);
966 case '\017': /* ^O & ^OPEN */
967 if (nextchar == '\0') {
968 sv_setpv(sv, PL_osname);
971 else if (strEQ(remaining, "PEN")) {
972 Perl_emulate_cop_io(aTHX_ &PL_compiling, sv);
976 sv_setiv(sv, (IV)PL_perldb);
978 case '\023': /* ^S */
980 if (PL_parser && PL_parser->lex_state != LEX_NOTPARSING)
983 sv_setiv(sv, PL_in_eval & ~(EVAL_INREQUIRE));
988 case '\024': /* ^T */
989 if (nextchar == '\0') {
991 sv_setnv(sv, PL_basetime);
993 sv_setiv(sv, (IV)PL_basetime);
996 else if (strEQ(remaining, "AINT"))
997 sv_setiv(sv, TAINTING_get
998 ? (TAINT_WARN_get || PL_unsafe ? -1 : 1)
1001 case '\025': /* $^UNICODE, $^UTF8LOCALE, $^UTF8CACHE */
1002 if (strEQ(remaining, "NICODE"))
1003 sv_setuv(sv, (UV) PL_unicode);
1004 else if (strEQ(remaining, "TF8LOCALE"))
1005 sv_setuv(sv, (UV) PL_utf8locale);
1006 else if (strEQ(remaining, "TF8CACHE"))
1007 sv_setiv(sv, (IV) PL_utf8cache);
1009 case '\027': /* ^W & $^WARNING_BITS */
1010 if (nextchar == '\0')
1011 sv_setiv(sv, (IV)cBOOL(PL_dowarn & G_WARN_ON));
1012 else if (strEQ(remaining, "ARNING_BITS")) {
1013 if (PL_compiling.cop_warnings == pWARN_NONE) {
1014 sv_setpvn(sv, WARN_NONEstring, WARNsize) ;
1016 else if (PL_compiling.cop_warnings == pWARN_STD) {
1019 else if (PL_compiling.cop_warnings == pWARN_ALL) {
1020 /* Get the bit mask for $warnings::Bits{all}, because
1021 * it could have been extended by warnings::register */
1022 HV * const bits = get_hv("warnings::Bits", 0);
1023 SV ** const bits_all = bits ? hv_fetchs(bits, "all", FALSE) : NULL;
1025 sv_copypv(sv, *bits_all);
1027 sv_setpvn(sv, WARN_ALLstring, WARNsize);
1030 sv_setpvn(sv, (char *) (PL_compiling.cop_warnings + 1),
1031 *PL_compiling.cop_warnings);
1035 else if (strEQ(remaining, "IN32_SLOPPY_STAT")) {
1036 sv_setiv(sv, w32_sloppystat);
1041 if (PL_curpm && (rx = PM_GETRE(PL_curpm))) {
1042 paren = RX_LASTPAREN(rx);
1044 goto do_numbuf_fetch;
1047 case '\016': /* ^N */
1048 if (PL_curpm && (rx = PM_GETRE(PL_curpm))) {
1049 paren = RX_LASTCLOSEPAREN(rx);
1051 goto do_numbuf_fetch;
1055 if (GvIO(PL_last_in_gv)) {
1056 sv_setiv(sv, (IV)IoLINES(GvIOp(PL_last_in_gv)));
1061 sv_setiv(sv, (IV)STATUS_CURRENT);
1062 #ifdef COMPLEX_STATUS
1063 SvUPGRADE(sv, SVt_PVLV);
1064 LvTARGOFF(sv) = PL_statusvalue;
1065 LvTARGLEN(sv) = PL_statusvalue_vms;
1070 if (GvIOp(PL_defoutgv))
1071 s = IoTOP_NAME(GvIOp(PL_defoutgv));
1075 sv_setpv(sv,GvENAME(PL_defoutgv));
1076 sv_catpvs(sv,"_TOP");
1080 if (GvIOp(PL_defoutgv))
1081 s = IoFMT_NAME(GvIOp(PL_defoutgv));
1083 s = GvENAME(PL_defoutgv);
1087 if (GvIO(PL_defoutgv))
1088 sv_setiv(sv, (IV)IoPAGE_LEN(GvIOp(PL_defoutgv)));
1091 if (GvIO(PL_defoutgv))
1092 sv_setiv(sv, (IV)IoLINES_LEFT(GvIOp(PL_defoutgv)));
1095 if (GvIO(PL_defoutgv))
1096 sv_setiv(sv, (IV)IoPAGE(GvIOp(PL_defoutgv)));
1105 if (GvIO(PL_defoutgv))
1106 sv_setiv(sv, (IV)(IoFLAGS(GvIOp(PL_defoutgv)) & IOf_FLUSH) != 0 );
1110 sv_copypv(sv, PL_ors_sv);
1116 IV const pid = (IV)PerlProc_getpid();
1117 if (isGV(mg->mg_obj) || SvIV(mg->mg_obj) != pid) {
1118 /* never set manually, or at least not since last fork */
1120 /* never unsafe, even if reading in a tainted expression */
1123 /* else a value has been assigned manually, so do nothing */
1127 sv_setuid(sv, PerlProc_getuid());
1130 sv_setuid(sv, PerlProc_geteuid());
1133 sv_setgid(sv, PerlProc_getgid());
1136 sv_setgid(sv, PerlProc_getegid());
1138 #ifdef HAS_GETGROUPS
1140 Groups_t *gary = NULL;
1141 I32 num_groups = getgroups(0, gary);
1142 if (num_groups > 0) {
1144 Newx(gary, num_groups, Groups_t);
1145 num_groups = getgroups(num_groups, gary);
1146 for (i = 0; i < num_groups; i++)
1147 Perl_sv_catpvf(aTHX_ sv, " %" IVdf, (IV)gary[i]);
1151 (void)SvIOK_on(sv); /* what a wonderful hack! */
1165 Perl_magic_getuvar(pTHX_ SV *sv, MAGIC *mg)
1167 struct ufuncs * const uf = (struct ufuncs *)mg->mg_ptr;
1169 PERL_ARGS_ASSERT_MAGIC_GETUVAR;
1171 if (uf && uf->uf_val)
1172 (*uf->uf_val)(aTHX_ uf->uf_index, sv);
1177 Perl_magic_setenv(pTHX_ SV *sv, MAGIC *mg)
1179 STRLEN len = 0, klen;
1180 const char * const key = MgPV_const(mg,klen);
1183 PERL_ARGS_ASSERT_MAGIC_SETENV;
1187 /* defined environment variables are byte strings; unfortunately
1188 there is no SvPVbyte_force_nomg(), so we must do this piecewise */
1189 (void)SvPV_force_nomg_nolen(sv);
1190 sv_utf8_downgrade(sv, /* fail_ok */ TRUE);
1192 Perl_ck_warner_d(aTHX_ packWARN(WARN_UTF8), "Wide character in %s", "setenv");
1198 my_setenv(key, s); /* does the deed */
1200 #ifdef DYNAMIC_ENV_FETCH
1201 /* We just undefd an environment var. Is a replacement */
1202 /* waiting in the wings? */
1204 SV ** const valp = hv_fetch(GvHVn(PL_envgv), key, klen, FALSE);
1206 s = SvOK(*valp) ? SvPV_const(*valp, len) : "";
1210 #if !defined(OS2) && !defined(WIN32) && !defined(MSDOS)
1211 /* And you'll never guess what the dog had */
1212 /* in its mouth... */
1214 MgTAINTEDDIR_off(mg);
1216 if (s && memEQs(key, klen, "DCL$PATH")) {
1217 char pathbuf[256], eltbuf[256], *cp, *elt;
1220 my_strlcpy(eltbuf, s, sizeof(eltbuf));
1222 do { /* DCL$PATH may be a search list */
1223 while (1) { /* as may dev portion of any element */
1224 if ( ((cp = strchr(elt,'[')) || (cp = strchr(elt,'<'))) ) {
1225 if ( *(cp+1) == '.' || *(cp+1) == '-' ||
1226 cando_by_name(S_IWUSR,0,elt) ) {
1227 MgTAINTEDDIR_on(mg);
1231 if ((cp = strchr(elt, ':')) != NULL)
1233 if (my_trnlnm(elt, eltbuf, j++))
1239 } while (my_trnlnm(s, pathbuf, i++) && (elt = pathbuf));
1242 if (s && memEQs(key, klen, "PATH")) {
1243 const char * const strend = s + len;
1245 /* set MGf_TAINTEDDIR if any component of the new path is
1246 * relative or world-writeable */
1247 while (s < strend) {
1251 #ifdef __VMS /* Hmm. How do we get $Config{path_sep} from C? */
1252 const char path_sep = PL_perllib_sep;
1254 const char path_sep = ':';
1256 s = delimcpy_no_escape(tmpbuf, tmpbuf + sizeof tmpbuf,
1257 s, strend, path_sep, &i);
1259 if (i >= (I32)sizeof tmpbuf /* too long -- assume the worst */
1261 /* no colon thus no device name -- assume relative path */
1262 || (PL_perllib_sep != ':' && !strchr(tmpbuf, ':'))
1263 /* Using Unix separator, e.g. under bash, so act line Unix */
1264 || (PL_perllib_sep == ':' && *tmpbuf != '/')
1266 || *tmpbuf != '/' /* no starting slash -- assume relative path */
1268 || (PerlLIO_stat(tmpbuf, &st) == 0 && (st.st_mode & 2)) ) {
1269 MgTAINTEDDIR_on(mg);
1275 #endif /* neither OS2 nor WIN32 nor MSDOS */
1281 Perl_magic_clearenv(pTHX_ SV *sv, MAGIC *mg)
1283 PERL_ARGS_ASSERT_MAGIC_CLEARENV;
1284 PERL_UNUSED_ARG(sv);
1285 my_setenv(MgPV_nolen_const(mg),NULL);
1290 Perl_magic_set_all_env(pTHX_ SV *sv, MAGIC *mg)
1292 PERL_ARGS_ASSERT_MAGIC_SET_ALL_ENV;
1293 PERL_UNUSED_ARG(mg);
1295 Perl_die(aTHX_ "Can't make list assignment to %%ENV on this system");
1297 if (PL_localizing) {
1300 hv_iterinit(MUTABLE_HV(sv));
1301 while ((entry = hv_iternext(MUTABLE_HV(sv)))) {
1303 my_setenv(hv_iterkey(entry, &keylen),
1304 SvPV_nolen_const(hv_iterval(MUTABLE_HV(sv), entry)));
1312 Perl_magic_clear_all_env(pTHX_ SV *sv, MAGIC *mg)
1314 PERL_ARGS_ASSERT_MAGIC_CLEAR_ALL_ENV;
1315 PERL_UNUSED_ARG(sv);
1316 PERL_UNUSED_ARG(mg);
1318 Perl_die(aTHX_ "Can't make list assignment to %%ENV on this system");
1326 #ifdef HAS_SIGPROCMASK
1328 restore_sigmask(pTHX_ SV *save_sv)
1330 const sigset_t * const ossetp = (const sigset_t *) SvPV_nolen_const( save_sv );
1331 (void)sigprocmask(SIG_SETMASK, ossetp, NULL);
1335 Perl_magic_getsig(pTHX_ SV *sv, MAGIC *mg)
1337 /* Are we fetching a signal entry? */
1338 int i = (I16)mg->mg_private;
1340 PERL_ARGS_ASSERT_MAGIC_GETSIG;
1344 const char * sig = MgPV_const(mg, siglen);
1345 mg->mg_private = i = whichsig_pvn(sig, siglen);
1350 sv_setsv(sv,PL_psig_ptr[i]);
1352 Sighandler_t sigstate = rsignal_state(i);
1353 #ifdef FAKE_PERSISTENT_SIGNAL_HANDLERS
1354 if (PL_sig_handlers_initted && PL_sig_ignoring[i])
1357 #ifdef FAKE_DEFAULT_SIGNAL_HANDLERS
1358 if (PL_sig_handlers_initted && PL_sig_defaulting[i])
1361 /* cache state so we don't fetch it again */
1362 if(sigstate == (Sighandler_t) SIG_IGN)
1363 sv_setpvs(sv,"IGNORE");
1366 PL_psig_ptr[i] = SvREFCNT_inc_simple_NN(sv);
1373 Perl_magic_clearsig(pTHX_ SV *sv, MAGIC *mg)
1375 PERL_ARGS_ASSERT_MAGIC_CLEARSIG;
1377 magic_setsig(NULL, mg);
1378 return sv_unmagic(sv, mg->mg_type);
1382 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
1383 Perl_csighandler(int sig, siginfo_t *sip PERL_UNUSED_DECL, void *uap PERL_UNUSED_DECL)
1385 Perl_csighandler(int sig)
1388 #ifdef PERL_GET_SIG_CONTEXT
1389 dTHXa(PERL_GET_SIG_CONTEXT);
1393 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
1394 #if defined(__cplusplus) && defined(__GNUC__)
1395 /* g++ doesn't support PERL_UNUSED_DECL, so the sip and uap
1396 * parameters would be warned about. */
1397 PERL_UNUSED_ARG(sip);
1398 PERL_UNUSED_ARG(uap);
1401 #ifdef FAKE_PERSISTENT_SIGNAL_HANDLERS
1402 (void) rsignal(sig, PL_csighandlerp);
1403 if (PL_sig_ignoring[sig]) return;
1405 #ifdef FAKE_DEFAULT_SIGNAL_HANDLERS
1406 if (PL_sig_defaulting[sig])
1407 #ifdef KILL_BY_SIGPRC
1408 exit((Perl_sig_to_vmscondition(sig)&STS$M_COND_ID)|STS$K_SEVERE|STS$M_INHIB_MSG);
1423 (PL_signals & PERL_SIGNALS_UNSAFE_FLAG))
1424 /* Call the perl level handler now--
1425 * with risk we may be in malloc() or being destructed etc. */
1426 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
1427 (*PL_sighandlerp)(sig, NULL, NULL);
1429 (*PL_sighandlerp)(sig);
1432 if (!PL_psig_pend) return;
1433 /* Set a flag to say this signal is pending, that is awaiting delivery after
1434 * the current Perl opcode completes */
1435 PL_psig_pend[sig]++;
1437 #ifndef SIG_PENDING_DIE_COUNT
1438 # define SIG_PENDING_DIE_COUNT 120
1440 /* Add one to say _a_ signal is pending */
1441 if (++PL_sig_pending >= SIG_PENDING_DIE_COUNT)
1442 Perl_croak(aTHX_ "Maximal count of pending signals (%lu) exceeded",
1443 (unsigned long)SIG_PENDING_DIE_COUNT);
1447 #if defined(FAKE_PERSISTENT_SIGNAL_HANDLERS) || defined(FAKE_DEFAULT_SIGNAL_HANDLERS)
1449 Perl_csighandler_init(void)
1452 if (PL_sig_handlers_initted) return;
1454 for (sig = 1; sig < SIG_SIZE; sig++) {
1455 #ifdef FAKE_DEFAULT_SIGNAL_HANDLERS
1457 PL_sig_defaulting[sig] = 1;
1458 (void) rsignal(sig, PL_csighandlerp);
1460 #ifdef FAKE_PERSISTENT_SIGNAL_HANDLERS
1461 PL_sig_ignoring[sig] = 0;
1464 PL_sig_handlers_initted = 1;
1468 #if defined HAS_SIGPROCMASK
1470 unblock_sigmask(pTHX_ void* newset)
1472 PERL_UNUSED_CONTEXT;
1473 sigprocmask(SIG_UNBLOCK, (sigset_t*)newset, NULL);
1478 Perl_despatch_signals(pTHX)
1482 for (sig = 1; sig < SIG_SIZE; sig++) {
1483 if (PL_psig_pend[sig]) {
1485 #ifdef HAS_SIGPROCMASK
1486 /* From sigaction(2) (FreeBSD man page):
1487 * | Signal routines normally execute with the signal that
1488 * | caused their invocation blocked, but other signals may
1490 * Emulation of this behavior (from within Perl) is enabled
1494 sigset_t newset, oldset;
1496 sigemptyset(&newset);
1497 sigaddset(&newset, sig);
1498 sigprocmask(SIG_BLOCK, &newset, &oldset);
1499 was_blocked = sigismember(&oldset, sig);
1501 SV* save_sv = newSVpvn((char *)(&newset), sizeof(sigset_t));
1503 SAVEFREESV(save_sv);
1504 SAVEDESTRUCTOR_X(unblock_sigmask, SvPV_nolen(save_sv));
1507 PL_psig_pend[sig] = 0;
1508 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
1509 (*PL_sighandlerp)(sig, NULL, NULL);
1511 (*PL_sighandlerp)(sig);
1513 #ifdef HAS_SIGPROCMASK
1522 /* sv of NULL signifies that we're acting as magic_clearsig. */
1524 Perl_magic_setsig(pTHX_ SV *sv, MAGIC *mg)
1529 /* Need to be careful with SvREFCNT_dec(), because that can have side
1530 * effects (due to closures). We must make sure that the new disposition
1531 * is in place before it is called.
1535 #ifdef HAS_SIGPROCMASK
1539 const char *s = MgPV_const(mg,len);
1541 PERL_ARGS_ASSERT_MAGIC_SETSIG;
1544 if (memEQs(s, len, "__DIE__"))
1546 else if (memEQs(s, len, "__WARN__")
1547 && (sv ? 1 : PL_warnhook != PERL_WARNHOOK_FATAL)) {
1548 /* Merge the existing behaviours, which are as follows:
1549 magic_setsig, we always set svp to &PL_warnhook
1550 (hence we always change the warnings handler)
1551 For magic_clearsig, we don't change the warnings handler if it's
1552 set to the &PL_warnhook. */
1555 SV *tmp = sv_newmortal();
1556 Perl_croak(aTHX_ "No such hook: %s",
1557 pv_pretty(tmp, s, len, 0, NULL, NULL, 0));
1561 if (*svp != PERL_WARNHOOK_FATAL)
1567 i = (I16)mg->mg_private;
1569 i = whichsig_pvn(s, len); /* ...no, a brick */
1570 mg->mg_private = (U16)i;
1574 SV *tmp = sv_newmortal();
1575 Perl_ck_warner(aTHX_ packWARN(WARN_SIGNAL), "No such signal: SIG%s",
1576 pv_pretty(tmp, s, len, 0, NULL, NULL, 0));
1580 #ifdef HAS_SIGPROCMASK
1581 /* Avoid having the signal arrive at a bad time, if possible. */
1584 sigprocmask(SIG_BLOCK, &set, &save);
1586 save_sv = newSVpvn((char *)(&save), sizeof(sigset_t));
1587 SAVEFREESV(save_sv);
1588 SAVEDESTRUCTOR_X(restore_sigmask, save_sv);
1591 #if defined(FAKE_PERSISTENT_SIGNAL_HANDLERS) || defined(FAKE_DEFAULT_SIGNAL_HANDLERS)
1592 if (!PL_sig_handlers_initted) Perl_csighandler_init();
1594 #ifdef FAKE_PERSISTENT_SIGNAL_HANDLERS
1595 PL_sig_ignoring[i] = 0;
1597 #ifdef FAKE_DEFAULT_SIGNAL_HANDLERS
1598 PL_sig_defaulting[i] = 0;
1600 to_dec = PL_psig_ptr[i];
1602 PL_psig_ptr[i] = SvREFCNT_inc_simple_NN(sv);
1603 SvTEMP_off(sv); /* Make sure it doesn't go away on us */
1605 /* Signals don't change name during the program's execution, so once
1606 they're cached in the appropriate slot of PL_psig_name, they can
1609 Ideally we'd find some way of making SVs at (C) compile time, or
1610 at least, doing most of the work. */
1611 if (!PL_psig_name[i]) {
1612 PL_psig_name[i] = newSVpvn(s, len);
1613 SvREADONLY_on(PL_psig_name[i]);
1616 SvREFCNT_dec(PL_psig_name[i]);
1617 PL_psig_name[i] = NULL;
1618 PL_psig_ptr[i] = NULL;
1621 if (sv && (isGV_with_GP(sv) || SvROK(sv))) {
1623 (void)rsignal(i, PL_csighandlerp);
1626 *svp = SvREFCNT_inc_simple_NN(sv);
1628 if (sv && SvOK(sv)) {
1629 s = SvPV_force(sv, len);
1633 if (sv && memEQs(s, len,"IGNORE")) {
1635 #ifdef FAKE_PERSISTENT_SIGNAL_HANDLERS
1636 PL_sig_ignoring[i] = 1;
1637 (void)rsignal(i, PL_csighandlerp);
1639 (void)rsignal(i, (Sighandler_t) SIG_IGN);
1643 else if (!sv || memEQs(s, len,"DEFAULT") || !len) {
1645 #ifdef FAKE_DEFAULT_SIGNAL_HANDLERS
1646 PL_sig_defaulting[i] = 1;
1647 (void)rsignal(i, PL_csighandlerp);
1649 (void)rsignal(i, (Sighandler_t) SIG_DFL);
1655 * We should warn if HINT_STRICT_REFS, but without
1656 * access to a known hint bit in a known OP, we can't
1657 * tell whether HINT_STRICT_REFS is in force or not.
1659 if (!strchr(s,':') && !strchr(s,'\''))
1660 Perl_sv_insert_flags(aTHX_ sv, 0, 0, STR_WITH_LEN("main::"),
1663 (void)rsignal(i, PL_csighandlerp);
1665 *svp = SvREFCNT_inc_simple_NN(sv);
1669 #ifdef HAS_SIGPROCMASK
1673 SvREFCNT_dec(to_dec);
1676 #endif /* !PERL_MICRO */
1679 Perl_magic_setisa(pTHX_ SV *sv, MAGIC *mg)
1681 PERL_ARGS_ASSERT_MAGIC_SETISA;
1682 PERL_UNUSED_ARG(sv);
1684 /* Skip _isaelem because _isa will handle it shortly */
1685 if (PL_delaymagic & DM_ARRAY_ISA && mg->mg_type == PERL_MAGIC_isaelem)
1688 return magic_clearisa(NULL, mg);
1691 /* sv of NULL signifies that we're acting as magic_setisa. */
1693 Perl_magic_clearisa(pTHX_ SV *sv, MAGIC *mg)
1696 PERL_ARGS_ASSERT_MAGIC_CLEARISA;
1698 /* Bail out if destruction is going on */
1699 if(PL_phase == PERL_PHASE_DESTRUCT) return 0;
1702 av_clear(MUTABLE_AV(sv));
1704 if (SvTYPE(mg->mg_obj) != SVt_PVGV && SvSMAGICAL(mg->mg_obj))
1705 /* This occurs with setisa_elem magic, which calls this
1707 mg = mg_find(mg->mg_obj, PERL_MAGIC_isa);
1710 if (SvTYPE(mg->mg_obj) == SVt_PVAV) { /* multiple stashes */
1711 SV **svp = AvARRAY((AV *)mg->mg_obj);
1712 I32 items = AvFILLp((AV *)mg->mg_obj) + 1;
1714 stash = GvSTASH((GV *)*svp++);
1715 if (stash && HvENAME(stash)) mro_isa_changed_in(stash);
1722 (const GV *)mg->mg_obj
1725 /* The stash may have been detached from the symbol table, so check its
1726 name before doing anything. */
1727 if (stash && HvENAME_get(stash))
1728 mro_isa_changed_in(stash);
1734 Perl_magic_getnkeys(pTHX_ SV *sv, MAGIC *mg)
1736 HV * const hv = MUTABLE_HV(LvTARG(sv));
1739 PERL_ARGS_ASSERT_MAGIC_GETNKEYS;
1740 PERL_UNUSED_ARG(mg);
1743 (void) hv_iterinit(hv);
1744 if (! SvTIED_mg((const SV *)hv, PERL_MAGIC_tied))
1747 while (hv_iternext(hv))
1752 sv_setiv(sv, (IV)i);
1757 Perl_magic_setnkeys(pTHX_ SV *sv, MAGIC *mg)
1759 PERL_ARGS_ASSERT_MAGIC_SETNKEYS;
1760 PERL_UNUSED_ARG(mg);
1762 hv_ksplit(MUTABLE_HV(LvTARG(sv)), SvIV(sv));
1768 =for apidoc magic_methcall
1770 Invoke a magic method (like FETCH).
1772 C<sv> and C<mg> are the tied thingy and the tie magic.
1774 C<meth> is the name of the method to call.
1776 C<argc> is the number of args (in addition to $self) to pass to the method.
1778 The C<flags> can be:
1780 G_DISCARD invoke method with G_DISCARD flag and don't
1782 G_UNDEF_FILL fill the stack with argc pointers to
1785 The arguments themselves are any values following the C<flags> argument.
1787 Returns the SV (if any) returned by the method, or C<NULL> on failure.
1794 Perl_magic_methcall(pTHX_ SV *sv, const MAGIC *mg, SV *meth, U32 flags,
1800 PERL_ARGS_ASSERT_MAGIC_METHCALL;
1804 if (flags & G_WRITING_TO_STDERR) {
1808 SAVESPTR(PL_stderrgv);
1812 PUSHSTACKi(PERLSI_MAGIC);
1815 /* EXTEND() expects a signed argc; don't wrap when casting */
1816 assert(argc <= I32_MAX);
1817 EXTEND(SP, (I32)argc+1);
1818 PUSHs(SvTIED_obj(sv, mg));
1819 if (flags & G_UNDEF_FILL) {
1821 PUSHs(&PL_sv_undef);
1823 } else if (argc > 0) {
1825 va_start(args, argc);
1828 SV *const sv = va_arg(args, SV *);
1835 if (flags & G_DISCARD) {
1836 call_sv(meth, G_SCALAR|G_DISCARD|G_METHOD_NAMED);
1839 if (call_sv(meth, G_SCALAR|G_METHOD_NAMED))
1840 ret = *PL_stack_sp--;
1843 if (flags & G_WRITING_TO_STDERR)
1849 /* wrapper for magic_methcall that creates the first arg */
1852 S_magic_methcall1(pTHX_ SV *sv, const MAGIC *mg, SV *meth, U32 flags,
1857 PERL_ARGS_ASSERT_MAGIC_METHCALL1;
1860 if (mg->mg_len >= 0) {
1861 arg1 = newSVpvn_flags(mg->mg_ptr, mg->mg_len, SVs_TEMP);
1863 else if (mg->mg_len == HEf_SVKEY)
1864 arg1 = MUTABLE_SV(mg->mg_ptr);
1866 else if (mg->mg_type == PERL_MAGIC_tiedelem) {
1867 arg1 = newSViv((IV)(mg->mg_len));
1871 return Perl_magic_methcall(aTHX_ sv, mg, meth, flags, n - 1, val);
1873 return Perl_magic_methcall(aTHX_ sv, mg, meth, flags, n, arg1, val);
1877 S_magic_methpack(pTHX_ SV *sv, const MAGIC *mg, SV *meth)
1881 PERL_ARGS_ASSERT_MAGIC_METHPACK;
1883 ret = magic_methcall1(sv, mg, meth, 0, 1, NULL);
1890 Perl_magic_getpack(pTHX_ SV *sv, MAGIC *mg)
1892 PERL_ARGS_ASSERT_MAGIC_GETPACK;
1894 if (mg->mg_type == PERL_MAGIC_tiedelem)
1895 mg->mg_flags |= MGf_GSKIP;
1896 magic_methpack(sv,mg,SV_CONST(FETCH));
1901 Perl_magic_setpack(pTHX_ SV *sv, MAGIC *mg)
1906 PERL_ARGS_ASSERT_MAGIC_SETPACK;
1908 /* in the code C<$tied{foo} = $val>, the "thing" that gets passed to
1909 * STORE() is not $val, but rather a PVLV (the sv in this call), whose
1910 * public flags indicate its value based on copying from $val. Doing
1911 * mg_set() on the PVLV temporarily does SvMAGICAL_off(), then calls us.
1912 * So STORE()'s $_[2] arg is a temporarily disarmed PVLV. This goes
1913 * wrong if $val happened to be tainted, as sv hasn't got magic
1914 * enabled, even though taint magic is in the chain. In which case,
1915 * fake up a temporary tainted value (this is easier than temporarily
1916 * re-enabling magic on sv). */
1918 if (TAINTING_get && (tmg = mg_find(sv, PERL_MAGIC_taint))
1919 && (tmg->mg_len & 1))
1921 val = sv_mortalcopy(sv);
1927 magic_methcall1(sv, mg, SV_CONST(STORE), G_DISCARD, 2, val);
1932 Perl_magic_clearpack(pTHX_ SV *sv, MAGIC *mg)
1934 PERL_ARGS_ASSERT_MAGIC_CLEARPACK;
1936 if (mg->mg_type == PERL_MAGIC_tiedscalar) return 0;
1937 return magic_methpack(sv,mg,SV_CONST(DELETE));
1942 Perl_magic_sizepack(pTHX_ SV *sv, MAGIC *mg)
1947 PERL_ARGS_ASSERT_MAGIC_SIZEPACK;
1949 retsv = magic_methcall1(sv, mg, SV_CONST(FETCHSIZE), 0, 1, NULL);
1951 retval = SvIV(retsv)-1;
1953 Perl_croak(aTHX_ "FETCHSIZE returned a negative value");
1955 return (U32) retval;
1959 Perl_magic_wipepack(pTHX_ SV *sv, MAGIC *mg)
1961 PERL_ARGS_ASSERT_MAGIC_WIPEPACK;
1963 Perl_magic_methcall(aTHX_ sv, mg, SV_CONST(CLEAR), G_DISCARD, 0);
1968 Perl_magic_nextpack(pTHX_ SV *sv, MAGIC *mg, SV *key)
1972 PERL_ARGS_ASSERT_MAGIC_NEXTPACK;
1974 ret = SvOK(key) ? Perl_magic_methcall(aTHX_ sv, mg, SV_CONST(NEXTKEY), 0, 1, key)
1975 : Perl_magic_methcall(aTHX_ sv, mg, SV_CONST(FIRSTKEY), 0, 0);
1982 Perl_magic_existspack(pTHX_ SV *sv, const MAGIC *mg)
1984 PERL_ARGS_ASSERT_MAGIC_EXISTSPACK;
1986 return magic_methpack(sv,mg,SV_CONST(EXISTS));
1990 Perl_magic_scalarpack(pTHX_ HV *hv, MAGIC *mg)
1993 SV * const tied = SvTIED_obj(MUTABLE_SV(hv), mg);
1994 HV * const pkg = SvSTASH((const SV *)SvRV(tied));
1996 PERL_ARGS_ASSERT_MAGIC_SCALARPACK;
1998 if (!gv_fetchmethod_autoload(pkg, "SCALAR", FALSE)) {
2000 if (HvEITER_get(hv))
2001 /* we are in an iteration so the hash cannot be empty */
2003 /* no xhv_eiter so now use FIRSTKEY */
2004 key = sv_newmortal();
2005 magic_nextpack(MUTABLE_SV(hv), mg, key);
2006 HvEITER_set(hv, NULL); /* need to reset iterator */
2007 return SvOK(key) ? &PL_sv_yes : &PL_sv_no;
2010 /* there is a SCALAR method that we can call */
2011 retval = Perl_magic_methcall(aTHX_ MUTABLE_SV(hv), mg, SV_CONST(SCALAR), 0, 0);
2013 retval = &PL_sv_undef;
2018 Perl_magic_setdbline(pTHX_ SV *sv, MAGIC *mg)
2022 PERL_ARGS_ASSERT_MAGIC_SETDBLINE;
2024 /* The magic ptr/len for the debugger's hash should always be an SV. */
2025 if (UNLIKELY(mg->mg_len != HEf_SVKEY)) {
2026 Perl_croak(aTHX_ "panic: magic_setdbline len=%" IVdf ", ptr='%s'",
2027 (IV)mg->mg_len, mg->mg_ptr);
2030 /* Use sv_2iv instead of SvIV() as the former generates smaller code, and
2031 setting/clearing debugger breakpoints is not a hot path. */
2032 svp = av_fetch(MUTABLE_AV(mg->mg_obj),
2033 sv_2iv(MUTABLE_SV((mg)->mg_ptr)), FALSE);
2035 if (svp && SvIOKp(*svp)) {
2036 OP * const o = INT2PTR(OP*,SvIVX(*svp));
2038 #ifdef PERL_DEBUG_READONLY_OPS
2039 Slab_to_rw(OpSLAB(o));
2041 /* set or clear breakpoint in the relevant control op */
2043 o->op_flags |= OPf_SPECIAL;
2045 o->op_flags &= ~OPf_SPECIAL;
2046 #ifdef PERL_DEBUG_READONLY_OPS
2047 Slab_to_ro(OpSLAB(o));
2055 Perl_magic_getarylen(pTHX_ SV *sv, const MAGIC *mg)
2057 AV * const obj = MUTABLE_AV(mg->mg_obj);
2059 PERL_ARGS_ASSERT_MAGIC_GETARYLEN;
2062 sv_setiv(sv, AvFILL(obj));
2070 Perl_magic_setarylen(pTHX_ SV *sv, MAGIC *mg)
2072 AV * const obj = MUTABLE_AV(mg->mg_obj);
2074 PERL_ARGS_ASSERT_MAGIC_SETARYLEN;
2077 av_fill(obj, SvIV(sv));
2079 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
2080 "Attempt to set length of freed array");
2086 Perl_magic_cleararylen_p(pTHX_ SV *sv, MAGIC *mg)
2088 PERL_ARGS_ASSERT_MAGIC_CLEARARYLEN_P;
2089 PERL_UNUSED_ARG(sv);
2090 PERL_UNUSED_CONTEXT;
2092 /* Reset the iterator when the array is cleared */
2093 #if IVSIZE == I32SIZE
2094 *((IV *) &(mg->mg_len)) = 0;
2097 *((IV *) mg->mg_ptr) = 0;
2104 Perl_magic_freearylen_p(pTHX_ SV *sv, MAGIC *mg)
2106 PERL_ARGS_ASSERT_MAGIC_FREEARYLEN_P;
2107 PERL_UNUSED_ARG(sv);
2109 /* during global destruction, mg_obj may already have been freed */
2110 if (PL_in_clean_all)
2113 mg = mg_find (mg->mg_obj, PERL_MAGIC_arylen);
2116 /* arylen scalar holds a pointer back to the array, but doesn't own a
2117 reference. Hence the we (the array) are about to go away with it
2118 still pointing at us. Clear its pointer, else it would be pointing
2119 at free memory. See the comment in sv_magic about reference loops,
2120 and why it can't own a reference to us. */
2127 Perl_magic_getpos(pTHX_ SV *sv, MAGIC *mg)
2129 SV* const lsv = LvTARG(sv);
2130 MAGIC * const found = mg_find_mglob(lsv);
2132 PERL_ARGS_ASSERT_MAGIC_GETPOS;
2133 PERL_UNUSED_ARG(mg);
2135 if (found && found->mg_len != -1) {
2136 STRLEN i = found->mg_len;
2137 if (found->mg_flags & MGf_BYTES && DO_UTF8(lsv))
2138 i = sv_pos_b2u_flags(lsv, i, SV_GMAGIC|SV_CONST_RETURN);
2147 Perl_magic_setpos(pTHX_ SV *sv, MAGIC *mg)
2149 SV* const lsv = LvTARG(sv);
2155 PERL_ARGS_ASSERT_MAGIC_SETPOS;
2156 PERL_UNUSED_ARG(mg);
2158 found = mg_find_mglob(lsv);
2162 found = sv_magicext_mglob(lsv);
2164 else if (!SvOK(sv)) {
2168 s = SvPV_const(lsv, len);
2173 const STRLEN ulen = sv_or_pv_len_utf8(lsv, s, len);
2183 else if (pos > (SSize_t)len)
2186 found->mg_len = pos;
2187 found->mg_flags &= ~(MGf_MINMATCH|MGf_BYTES);
2193 Perl_magic_getsubstr(pTHX_ SV *sv, MAGIC *mg)
2196 SV * const lsv = LvTARG(sv);
2197 const char * const tmps = SvPV_const(lsv,len);
2198 STRLEN offs = LvTARGOFF(sv);
2199 STRLEN rem = LvTARGLEN(sv);
2200 const bool negoff = LvFLAGS(sv) & LVf_NEG_OFF;
2201 const bool negrem = LvFLAGS(sv) & LVf_NEG_LEN;
2203 PERL_ARGS_ASSERT_MAGIC_GETSUBSTR;
2204 PERL_UNUSED_ARG(mg);
2206 if (!translate_substr_offsets(
2207 SvUTF8(lsv) ? sv_or_pv_len_utf8(lsv, tmps, len) : len,
2208 negoff ? -(IV)offs : (IV)offs, !negoff,
2209 negrem ? -(IV)rem : (IV)rem, !negrem, &offs, &rem
2211 Perl_ck_warner(aTHX_ packWARN(WARN_SUBSTR), "substr outside of string");
2217 offs = sv_or_pv_pos_u2b(lsv, tmps, offs, &rem);
2218 sv_setpvn(sv, tmps + offs, rem);
2225 Perl_magic_setsubstr(pTHX_ SV *sv, MAGIC *mg)
2227 STRLEN len, lsv_len, oldtarglen, newtarglen;
2228 const char * const tmps = SvPV_const(sv, len);
2229 SV * const lsv = LvTARG(sv);
2230 STRLEN lvoff = LvTARGOFF(sv);
2231 STRLEN lvlen = LvTARGLEN(sv);
2232 const bool negoff = LvFLAGS(sv) & LVf_NEG_OFF;
2233 const bool neglen = LvFLAGS(sv) & LVf_NEG_LEN;
2235 PERL_ARGS_ASSERT_MAGIC_SETSUBSTR;
2236 PERL_UNUSED_ARG(mg);
2240 Perl_ck_warner(aTHX_ packWARN(WARN_SUBSTR),
2241 "Attempt to use reference as lvalue in substr"
2243 SvPV_force_nomg(lsv,lsv_len);
2244 if (SvUTF8(lsv)) lsv_len = sv_len_utf8_nomg(lsv);
2245 if (!translate_substr_offsets(
2247 negoff ? -(IV)lvoff : (IV)lvoff, !negoff,
2248 neglen ? -(IV)lvlen : (IV)lvlen, !neglen, &lvoff, &lvlen
2250 Perl_croak(aTHX_ "substr outside of string");
2253 sv_utf8_upgrade_nomg(lsv);
2254 lvoff = sv_pos_u2b_flags(lsv, lvoff, &lvlen, SV_CONST_RETURN);
2255 sv_insert_flags(lsv, lvoff, lvlen, tmps, len, 0);
2256 newtarglen = sv_or_pv_len_utf8(sv, tmps, len);
2259 else if (SvUTF8(lsv)) {
2261 lvoff = sv_pos_u2b_flags(lsv, lvoff, &lvlen, SV_CONST_RETURN);
2263 utf8 = (char*)bytes_to_utf8((U8*)tmps, &len);
2264 sv_insert_flags(lsv, lvoff, lvlen, utf8, len, 0);
2268 sv_insert_flags(lsv, lvoff, lvlen, tmps, len, 0);
2271 if (!neglen) LvTARGLEN(sv) = newtarglen;
2272 if (negoff) LvTARGOFF(sv) += newtarglen - oldtarglen;
2278 Perl_magic_gettaint(pTHX_ SV *sv, MAGIC *mg)
2280 PERL_ARGS_ASSERT_MAGIC_GETTAINT;
2281 PERL_UNUSED_ARG(sv);
2282 #ifdef NO_TAINT_SUPPORT
2283 PERL_UNUSED_ARG(mg);
2286 TAINT_IF((PL_localizing != 1) && (mg->mg_len & 1) && IN_PERL_RUNTIME);
2291 Perl_magic_settaint(pTHX_ SV *sv, MAGIC *mg)
2293 PERL_ARGS_ASSERT_MAGIC_SETTAINT;
2294 PERL_UNUSED_ARG(sv);
2296 /* update taint status */
2305 Perl_magic_getvec(pTHX_ SV *sv, MAGIC *mg)
2307 SV * const lsv = LvTARG(sv);
2308 char errflags = LvFLAGS(sv);
2310 PERL_ARGS_ASSERT_MAGIC_GETVEC;
2311 PERL_UNUSED_ARG(mg);
2313 /* non-zero errflags implies deferred out-of-range condition */
2314 assert(!(errflags & ~(LVf_NEG_OFF|LVf_OUT_OF_RANGE)));
2315 sv_setuv(sv, errflags ? 0 : do_vecget(lsv, LvTARGOFF(sv), LvTARGLEN(sv)));
2321 Perl_magic_setvec(pTHX_ SV *sv, MAGIC *mg)
2323 PERL_ARGS_ASSERT_MAGIC_SETVEC;
2324 PERL_UNUSED_ARG(mg);
2325 do_vecset(sv); /* XXX slurp this routine */
2330 Perl_defelem_target(pTHX_ SV *sv, MAGIC *mg)
2333 PERL_ARGS_ASSERT_DEFELEM_TARGET;
2334 if (!mg) mg = mg_find(sv, PERL_MAGIC_defelem);
2336 if (LvTARGLEN(sv)) {
2338 SV * const ahv = LvTARG(sv);
2339 HE * const he = hv_fetch_ent(MUTABLE_HV(ahv), mg->mg_obj, FALSE, 0);
2343 else if (LvSTARGOFF(sv) >= 0) {
2344 AV *const av = MUTABLE_AV(LvTARG(sv));
2345 if (LvSTARGOFF(sv) <= AvFILL(av))
2347 if (SvRMAGICAL(av)) {
2348 SV * const * const svp = av_fetch(av, LvSTARGOFF(sv), 0);
2349 targ = svp ? *svp : NULL;
2352 targ = AvARRAY(av)[LvSTARGOFF(sv)];
2355 if (targ && (targ != &PL_sv_undef)) {
2356 /* somebody else defined it for us */
2357 SvREFCNT_dec(LvTARG(sv));
2358 LvTARG(sv) = SvREFCNT_inc_simple_NN(targ);
2360 SvREFCNT_dec(mg->mg_obj);
2362 mg->mg_flags &= ~MGf_REFCOUNTED;
2371 Perl_magic_getdefelem(pTHX_ SV *sv, MAGIC *mg)
2373 PERL_ARGS_ASSERT_MAGIC_GETDEFELEM;
2375 sv_setsv(sv, defelem_target(sv, mg));
2380 Perl_magic_setdefelem(pTHX_ SV *sv, MAGIC *mg)
2382 PERL_ARGS_ASSERT_MAGIC_SETDEFELEM;
2383 PERL_UNUSED_ARG(mg);
2387 sv_setsv(LvTARG(sv), sv);
2388 SvSETMAGIC(LvTARG(sv));
2394 Perl_vivify_defelem(pTHX_ SV *sv)
2399 PERL_ARGS_ASSERT_VIVIFY_DEFELEM;
2401 if (!LvTARGLEN(sv) || !(mg = mg_find(sv, PERL_MAGIC_defelem)))
2404 SV * const ahv = LvTARG(sv);
2405 HE * const he = hv_fetch_ent(MUTABLE_HV(ahv), mg->mg_obj, TRUE, 0);
2408 if (!value || value == &PL_sv_undef)
2409 Perl_croak(aTHX_ PL_no_helem_sv, SVfARG(mg->mg_obj));
2411 else if (LvSTARGOFF(sv) < 0)
2412 Perl_croak(aTHX_ PL_no_aelem, LvSTARGOFF(sv));
2414 AV *const av = MUTABLE_AV(LvTARG(sv));
2415 if ((I32)LvTARGLEN(sv) < 0 && LvSTARGOFF(sv) > AvFILL(av))
2416 LvTARG(sv) = NULL; /* array can't be extended */
2418 SV* const * const svp = av_fetch(av, LvSTARGOFF(sv), TRUE);
2419 if (!svp || !(value = *svp))
2420 Perl_croak(aTHX_ PL_no_aelem, LvSTARGOFF(sv));
2423 SvREFCNT_inc_simple_void(value);
2424 SvREFCNT_dec(LvTARG(sv));
2427 SvREFCNT_dec(mg->mg_obj);
2429 mg->mg_flags &= ~MGf_REFCOUNTED;
2433 Perl_magic_killbackrefs(pTHX_ SV *sv, MAGIC *mg)
2435 PERL_ARGS_ASSERT_MAGIC_KILLBACKREFS;
2436 Perl_sv_kill_backrefs(aTHX_ sv, MUTABLE_AV(mg->mg_obj));
2441 Perl_magic_setmglob(pTHX_ SV *sv, MAGIC *mg)
2443 PERL_ARGS_ASSERT_MAGIC_SETMGLOB;
2444 PERL_UNUSED_CONTEXT;
2445 PERL_UNUSED_ARG(sv);
2451 Perl_magic_setuvar(pTHX_ SV *sv, MAGIC *mg)
2453 const struct ufuncs * const uf = (struct ufuncs *)mg->mg_ptr;
2455 PERL_ARGS_ASSERT_MAGIC_SETUVAR;
2457 if (uf && uf->uf_set)
2458 (*uf->uf_set)(aTHX_ uf->uf_index, sv);
2463 Perl_magic_setregexp(pTHX_ SV *sv, MAGIC *mg)
2465 const char type = mg->mg_type;
2467 PERL_ARGS_ASSERT_MAGIC_SETREGEXP;
2469 assert( type == PERL_MAGIC_fm
2470 || type == PERL_MAGIC_qr
2471 || type == PERL_MAGIC_bm);
2472 return sv_unmagic(sv, type);
2475 #ifdef USE_LOCALE_COLLATE
2477 Perl_magic_setcollxfrm(pTHX_ SV *sv, MAGIC *mg)
2479 PERL_ARGS_ASSERT_MAGIC_SETCOLLXFRM;
2482 * RenE<eacute> Descartes said "I think not."
2483 * and vanished with a faint plop.
2485 PERL_UNUSED_CONTEXT;
2486 PERL_UNUSED_ARG(sv);
2488 Safefree(mg->mg_ptr);
2494 #endif /* USE_LOCALE_COLLATE */
2496 /* Just clear the UTF-8 cache data. */
2498 Perl_magic_setutf8(pTHX_ SV *sv, MAGIC *mg)
2500 PERL_ARGS_ASSERT_MAGIC_SETUTF8;
2501 PERL_UNUSED_CONTEXT;
2502 PERL_UNUSED_ARG(sv);
2503 Safefree(mg->mg_ptr); /* The mg_ptr holds the pos cache. */
2505 mg->mg_len = -1; /* The mg_len holds the len cache. */
2510 Perl_magic_setlvref(pTHX_ SV *sv, MAGIC *mg)
2512 const char *bad = NULL;
2513 PERL_ARGS_ASSERT_MAGIC_SETLVREF;
2514 if (!SvROK(sv)) Perl_croak(aTHX_ "Assigned value is not a reference");
2515 switch (mg->mg_private & OPpLVREF_TYPE) {
2517 if (SvTYPE(SvRV(sv)) > SVt_PVLV)
2521 if (SvTYPE(SvRV(sv)) != SVt_PVAV)
2525 if (SvTYPE(SvRV(sv)) != SVt_PVHV)
2529 if (SvTYPE(SvRV(sv)) != SVt_PVCV)
2533 /* diag_listed_as: Assigned value is not %s reference */
2534 Perl_croak(aTHX_ "Assigned value is not a%s reference", bad);
2535 switch (mg->mg_obj ? SvTYPE(mg->mg_obj) : 0) {
2538 SV * const old = PAD_SV(mg->mg_len);
2539 PAD_SETSV(mg->mg_len, SvREFCNT_inc_NN(SvRV(sv)));
2544 gv_setref(mg->mg_obj, sv);
2545 SvSETMAGIC(mg->mg_obj);
2548 av_store((AV *)mg->mg_obj, SvIV((SV *)mg->mg_ptr),
2549 SvREFCNT_inc_simple_NN(SvRV(sv)));
2552 (void)hv_store_ent((HV *)mg->mg_obj, (SV *)mg->mg_ptr,
2553 SvREFCNT_inc_simple_NN(SvRV(sv)), 0);
2555 if (mg->mg_flags & MGf_PERSIST)
2556 NOOP; /* This sv is in use as an iterator var and will be reused,
2557 so we must leave the magic. */
2559 /* This sv could be returned by the assignment op, so clear the
2560 magic, as lvrefs are an implementation detail that must not be
2561 leaked to the user. */
2562 sv_unmagic(sv, PERL_MAGIC_lvref);
2567 S_set_dollarzero(pTHX_ SV *sv)
2568 PERL_TSA_REQUIRES(PL_dollarzero_mutex)
2575 #ifdef HAS_SETPROCTITLE
2576 /* The BSDs don't show the argv[] in ps(1) output, they
2577 * show a string from the process struct and provide
2578 * the setproctitle() routine to manipulate that. */
2579 if (PL_origalen != 1) {
2580 s = SvPV_const(sv, len);
2581 # if __FreeBSD_version > 410001 || defined(__DragonFly__)
2582 /* The leading "-" removes the "perl: " prefix,
2583 * but not the "(perl) suffix from the ps(1)
2584 * output, because that's what ps(1) shows if the
2585 * argv[] is modified. */
2586 setproctitle("-%s", s);
2587 # else /* old FreeBSDs, NetBSD, OpenBSD, anyBSD */
2588 /* This doesn't really work if you assume that
2589 * $0 = 'foobar'; will wipe out 'perl' from the $0
2590 * because in ps(1) output the result will be like
2591 * sprintf("perl: %s (perl)", s)
2592 * I guess this is a security feature:
2593 * one (a user process) cannot get rid of the original name.
2595 setproctitle("%s", s);
2598 #elif defined(__hpux) && defined(PSTAT_SETCMD)
2599 if (PL_origalen != 1) {
2601 s = SvPV_const(sv, len);
2602 un.pst_command = (char *)s;
2603 pstat(PSTAT_SETCMD, un, len, 0, 0);
2606 if (PL_origalen > 1) {
2608 /* PL_origalen is set in perl_parse(). */
2609 s = SvPV_force(sv,len);
2610 if (len >= (STRLEN)PL_origalen-1) {
2611 /* Longer than original, will be truncated. We assume that
2612 * PL_origalen bytes are available. */
2613 Copy(s, PL_origargv[0], PL_origalen-1, char);
2616 /* Shorter than original, will be padded. */
2618 /* Special case for Mac OS X: see [perl #38868] */
2621 /* Is the space counterintuitive? Yes.
2622 * (You were expecting \0?)
2623 * Does it work? Seems to. (In Linux 2.4.20 at least.)
2625 const int pad = ' ';
2627 Copy(s, PL_origargv[0], len, char);
2628 PL_origargv[0][len] = 0;
2629 memset(PL_origargv[0] + len + 1,
2630 pad, PL_origalen - len - 1);
2632 PL_origargv[0][PL_origalen-1] = 0;
2633 for (i = 1; i < PL_origargc; i++)
2635 #ifdef HAS_PRCTL_SET_NAME
2636 /* Set the legacy process name in addition to the POSIX name on Linux */
2637 if (prctl(PR_SET_NAME, (unsigned long)s, 0, 0, 0) != 0) {
2638 /* diag_listed_as: SKIPME */
2639 Perl_croak(aTHX_ "Can't set $0 with prctl(): %s", Strerror(errno));
2647 Perl_magic_set(pTHX_ SV *sv, MAGIC *mg)
2658 PERL_ARGS_ASSERT_MAGIC_SET;
2662 if (PL_curpm && (rx = PM_GETRE(PL_curpm))) {
2664 CALLREG_NUMBUF_STORE((REGEXP * const)rx,paren,sv);
2666 /* Croak with a READONLY error when a numbered match var is
2667 * set without a previous pattern match. Unless it's C<local $1>
2670 if (!PL_localizing) {
2671 Perl_croak_no_modify();
2677 switch (*mg->mg_ptr) {
2678 case '\001': /* ^A */
2679 if (SvOK(sv)) sv_copypv(PL_bodytarget, sv);
2680 else SvOK_off(PL_bodytarget);
2681 FmLINES(PL_bodytarget) = 0;
2682 if (SvPOK(PL_bodytarget)) {
2683 char *s = SvPVX(PL_bodytarget);
2684 while ( ((s = strchr(s, '\n'))) ) {
2685 FmLINES(PL_bodytarget)++;
2689 /* mg_set() has temporarily made sv non-magical */
2691 if ((tmg = mg_find(sv,PERL_MAGIC_taint)) && tmg->mg_len & 1)
2692 SvTAINTED_on(PL_bodytarget);
2694 SvTAINTED_off(PL_bodytarget);
2697 case '\003': /* ^C */
2698 PL_minus_c = cBOOL(SvIV(sv));
2701 case '\004': /* ^D */
2704 const char *s = SvPV_nolen_const(sv);
2705 PL_debug = get_debug_opts(&s, 0) | DEBUG_TOP_FLAG;
2706 if (DEBUG_x_TEST || DEBUG_B_TEST)
2707 dump_all_perl(!DEBUG_B_TEST);
2710 PL_debug = (SvIV(sv)) | DEBUG_TOP_FLAG;
2713 case '\005': /* ^E */
2714 if (*(mg->mg_ptr+1) == '\0') {
2716 set_vaxc_errno(SvIV(sv));
2719 SetLastError( SvIV(sv) );
2722 os2_setsyserrno(SvIV(sv));
2724 /* will anyone ever use this? */
2725 SETERRNO(SvIV(sv), 4);
2730 else if (strEQ(mg->mg_ptr + 1, "NCODING") && SvOK(sv))
2731 Perl_croak(aTHX_ "${^ENCODING} is no longer supported");
2733 case '\006': /* ^F */
2734 PL_maxsysfd = SvIV(sv);
2736 case '\010': /* ^H */
2738 U32 save_hints = PL_hints;
2739 PL_hints = SvUV(sv);
2741 /* If wasn't UTF-8, and now is, notify the parser */
2742 if ((PL_hints & HINT_UTF8) && ! (save_hints & HINT_UTF8)) {
2743 notify_parser_that_changed_to_utf8();
2747 case '\011': /* ^I */ /* NOT \t in EBCDIC */
2748 Safefree(PL_inplace);
2749 PL_inplace = SvOK(sv) ? savesvpv(sv) : NULL;
2751 case '\016': /* ^N */
2752 if (PL_curpm && (rx = PM_GETRE(PL_curpm))
2753 && (paren = RX_LASTCLOSEPAREN(rx))) goto setparen_got_rx;
2755 case '\017': /* ^O */
2756 if (*(mg->mg_ptr+1) == '\0') {
2757 Safefree(PL_osname);
2760 TAINT_PROPER("assigning to $^O");
2761 PL_osname = savesvpv(sv);
2764 else if (strEQ(mg->mg_ptr, "\017PEN")) {
2766 const char *const start = SvPV(sv, len);
2767 const char *out = (const char*)memchr(start, '\0', len);
2771 PL_compiling.cop_hints |= HINT_LEXICAL_IO_IN | HINT_LEXICAL_IO_OUT;
2772 PL_hints |= HINT_LEXICAL_IO_IN | HINT_LEXICAL_IO_OUT;
2774 /* Opening for input is more common than opening for output, so
2775 ensure that hints for input are sooner on linked list. */
2776 tmp = out ? newSVpvn_flags(out + 1, start + len - out - 1,
2778 : newSVpvs_flags("", SvUTF8(sv));
2779 (void)hv_stores(GvHV(PL_hintgv), "open>", tmp);
2782 tmp = newSVpvn_flags(start, out ? (STRLEN)(out - start) : len,
2784 (void)hv_stores(GvHV(PL_hintgv), "open<", tmp);
2788 case '\020': /* ^P */
2789 PL_perldb = SvIV(sv);
2790 if (PL_perldb && !PL_DBsingle)
2793 case '\024': /* ^T */
2795 PL_basetime = (Time_t)(SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv));
2797 PL_basetime = (Time_t)SvIV(sv);
2800 case '\025': /* ^UTF8CACHE */
2801 if (strEQ(mg->mg_ptr+1, "TF8CACHE")) {
2802 PL_utf8cache = (signed char) sv_2iv(sv);
2805 case '\027': /* ^W & $^WARNING_BITS */
2806 if (*(mg->mg_ptr+1) == '\0') {
2807 if ( ! (PL_dowarn & G_WARN_ALL_MASK)) {
2809 PL_dowarn = (PL_dowarn & ~G_WARN_ON)
2810 | (i ? G_WARN_ON : G_WARN_OFF) ;
2813 else if (strEQ(mg->mg_ptr+1, "ARNING_BITS")) {
2814 if ( ! (PL_dowarn & G_WARN_ALL_MASK)) {
2816 PL_compiling.cop_warnings = pWARN_STD;
2821 int accumulate = 0 ;
2822 int any_fatals = 0 ;
2823 const char * const ptr = SvPV_const(sv, len) ;
2824 for (i = 0 ; i < len ; ++i) {
2825 accumulate |= ptr[i] ;
2826 any_fatals |= (ptr[i] & 0xAA) ;
2829 if (!specialWARN(PL_compiling.cop_warnings))
2830 PerlMemShared_free(PL_compiling.cop_warnings);
2831 PL_compiling.cop_warnings = pWARN_NONE;
2833 /* Yuck. I can't see how to abstract this: */
2835 ((STRLEN *)SvPV_nolen_const(sv)) - 1,
2839 if (!specialWARN(PL_compiling.cop_warnings))
2840 PerlMemShared_free(PL_compiling.cop_warnings);
2841 PL_compiling.cop_warnings = pWARN_ALL;
2842 PL_dowarn |= G_WARN_ONCE ;
2846 const char *const p = SvPV_const(sv, len);
2848 PL_compiling.cop_warnings
2849 = Perl_new_warnings_bitfield(aTHX_ PL_compiling.cop_warnings,
2852 if (isWARN_on(PL_compiling.cop_warnings, WARN_ONCE))
2853 PL_dowarn |= G_WARN_ONCE ;
2860 else if (strEQ(mg->mg_ptr+1, "IN32_SLOPPY_STAT")) {
2861 w32_sloppystat = (bool)sv_true(sv);
2866 if (PL_localizing) {
2867 if (PL_localizing == 1)
2868 SAVESPTR(PL_last_in_gv);
2870 else if (SvOK(sv) && GvIO(PL_last_in_gv))
2871 IoLINES(GvIOp(PL_last_in_gv)) = SvIV(sv);
2874 Safefree(IoTOP_NAME(GvIOp(PL_defoutgv)));
2875 IoTOP_NAME(GvIOp(PL_defoutgv)) = savesvpv(sv);
2876 IoTOP_GV(GvIOp(PL_defoutgv)) = gv_fetchsv(sv, GV_ADD, SVt_PVIO);
2879 Safefree(IoFMT_NAME(GvIOp(PL_defoutgv)));
2880 IoFMT_NAME(GvIOp(PL_defoutgv)) = savesvpv(sv);
2881 IoFMT_GV(GvIOp(PL_defoutgv)) = gv_fetchsv(sv, GV_ADD, SVt_PVIO);
2884 IoPAGE_LEN(GvIOp(PL_defoutgv)) = (SvIV(sv));
2887 IoLINES_LEFT(GvIOp(PL_defoutgv)) = (SvIV(sv));
2888 if (IoLINES_LEFT(GvIOp(PL_defoutgv)) < 0L)
2889 IoLINES_LEFT(GvIOp(PL_defoutgv)) = 0L;
2892 IoPAGE(GvIOp(PL_defoutgv)) = (SvIV(sv));
2896 IO * const io = GvIO(PL_defoutgv);
2899 if ((SvIV(sv)) == 0)
2900 IoFLAGS(io) &= ~IOf_FLUSH;
2902 if (!(IoFLAGS(io) & IOf_FLUSH)) {
2903 PerlIO *ofp = IoOFP(io);
2905 (void)PerlIO_flush(ofp);
2906 IoFLAGS(io) |= IOf_FLUSH;
2914 SV *referent = SvRV(sv);
2915 const char *reftype = sv_reftype(referent, 0);
2916 /* XXX: dodgy type check: This leaves me feeling dirty, but
2917 * the alternative is to copy pretty much the entire
2918 * sv_reftype() into this routine, or to do a full string
2919 * comparison on the return of sv_reftype() both of which
2920 * make me feel worse! NOTE, do not modify this comment
2921 * without reviewing the corresponding comment in
2922 * sv_reftype(). - Yves */
2923 if (reftype[0] == 'S' || reftype[0] == 'L') {
2924 IV val = SvIV(referent);
2926 sv_setsv(sv, PL_rs);
2927 Perl_croak(aTHX_ "Setting $/ to a reference to %s is forbidden",
2928 val < 0 ? "a negative integer" : "zero");
2931 sv_setsv(sv, PL_rs);
2932 /* diag_listed_as: Setting $/ to %s reference is forbidden */
2933 Perl_croak(aTHX_ "Setting $/ to a%s %s reference is forbidden",
2934 *reftype == 'A' ? "n" : "", reftype);
2937 SvREFCNT_dec(PL_rs);
2938 PL_rs = newSVsv(sv);
2942 SvREFCNT_dec(PL_ors_sv);
2944 PL_ors_sv = newSVsv(sv);
2952 Perl_croak(aTHX_ "Assigning non-zero to $[ is no longer possible");
2955 #ifdef COMPLEX_STATUS
2956 if (PL_localizing == 2) {
2957 SvUPGRADE(sv, SVt_PVLV);
2958 PL_statusvalue = LvTARGOFF(sv);
2959 PL_statusvalue_vms = LvTARGLEN(sv);
2963 #ifdef VMSISH_STATUS
2965 STATUS_NATIVE_CHILD_SET((U32)SvIV(sv));
2968 STATUS_UNIX_EXIT_SET(SvIV(sv));
2973 # define PERL_VMS_BANG vaxc$errno
2975 # define PERL_VMS_BANG 0
2977 #if defined(WIN32) && ! defined(UNDER_CE)
2978 SETERRNO(win32_get_errno(SvIOK(sv) ? SvIVX(sv) : SvOK(sv) ? sv_2iv(sv) : 0),
2979 (SvIV(sv) == EVMSERR) ? 4 : PERL_VMS_BANG);
2981 SETERRNO(SvIOK(sv) ? SvIVX(sv) : SvOK(sv) ? sv_2iv(sv) : 0,
2982 (SvIV(sv) == EVMSERR) ? 4 : PERL_VMS_BANG);
2988 /* XXX $< currently silently ignores failures */
2989 const Uid_t new_uid = SvUID(sv);
2990 PL_delaymagic_uid = new_uid;
2991 if (PL_delaymagic) {
2992 PL_delaymagic |= DM_RUID;
2993 break; /* don't do magic till later */
2996 PERL_UNUSED_RESULT(setruid(new_uid));
2999 PERL_UNUSED_RESULT(setreuid(new_uid, (Uid_t)-1));
3001 #ifdef HAS_SETRESUID
3002 PERL_UNUSED_RESULT(setresuid(new_uid, (Uid_t)-1, (Uid_t)-1));
3004 if (new_uid == PerlProc_geteuid()) { /* special case $< = $> */
3006 /* workaround for Darwin's setuid peculiarity, cf [perl #24122] */
3007 if (new_uid != 0 && PerlProc_getuid() == 0)
3008 PERL_UNUSED_RESULT(PerlProc_setuid(0));
3010 PERL_UNUSED_RESULT(PerlProc_setuid(new_uid));
3012 Perl_croak(aTHX_ "setruid() not implemented");
3021 /* XXX $> currently silently ignores failures */
3022 const Uid_t new_euid = SvUID(sv);
3023 PL_delaymagic_euid = new_euid;
3024 if (PL_delaymagic) {
3025 PL_delaymagic |= DM_EUID;
3026 break; /* don't do magic till later */
3029 PERL_UNUSED_RESULT(seteuid(new_euid));
3032 PERL_UNUSED_RESULT(setreuid((Uid_t)-1, new_euid));
3034 #ifdef HAS_SETRESUID
3035 PERL_UNUSED_RESULT(setresuid((Uid_t)-1, new_euid, (Uid_t)-1));
3037 if (new_euid == PerlProc_getuid()) /* special case $> = $< */
3038 PERL_UNUSED_RESULT(PerlProc_setuid(new_euid));
3040 Perl_croak(aTHX_ "seteuid() not implemented");
3049 /* XXX $( currently silently ignores failures */
3050 const Gid_t new_gid = SvGID(sv);
3051 PL_delaymagic_gid = new_gid;
3052 if (PL_delaymagic) {
3053 PL_delaymagic |= DM_RGID;
3054 break; /* don't do magic till later */
3057 PERL_UNUSED_RESULT(setrgid(new_gid));
3060 PERL_UNUSED_RESULT(setregid(new_gid, (Gid_t)-1));
3062 #ifdef HAS_SETRESGID
3063 PERL_UNUSED_RESULT(setresgid(new_gid, (Gid_t)-1, (Gid_t) -1));
3065 if (new_gid == PerlProc_getegid()) /* special case $( = $) */
3066 PERL_UNUSED_RESULT(PerlProc_setgid(new_gid));
3068 Perl_croak(aTHX_ "setrgid() not implemented");
3077 /* (hv) best guess: maybe we'll need configure probes to do a better job,
3078 * but you can override it if you need to.
3081 #define INVALID_GID ((Gid_t)-1)
3083 /* XXX $) currently silently ignores failures */
3085 #ifdef HAS_SETGROUPS
3087 const char *p = SvPV_const(sv, len);
3088 Groups_t *gary = NULL;
3091 #ifdef _SC_NGROUPS_MAX
3092 int maxgrp = sysconf(_SC_NGROUPS_MAX);
3097 int maxgrp = NGROUPS;
3102 if (grok_atoUV(p, &uv, &endptr))
3103 new_egid = (Gid_t)uv;
3105 new_egid = INVALID_GID;
3108 for (i = 0; i < maxgrp; ++i) {
3117 Newx(gary, i + 1, Groups_t);
3119 Renew(gary, i + 1, Groups_t);
3120 if (grok_atoUV(p, &uv, &endptr))
3121 gary[i] = (Groups_t)uv;
3123 gary[i] = INVALID_GID;
3128 PERL_UNUSED_RESULT(setgroups(i, gary));
3131 #else /* HAS_SETGROUPS */
3132 new_egid = SvGID(sv);
3133 #endif /* HAS_SETGROUPS */
3134 PL_delaymagic_egid = new_egid;
3135 if (PL_delaymagic) {
3136 PL_delaymagic |= DM_EGID;
3137 break; /* don't do magic till later */
3140 PERL_UNUSED_RESULT(setegid(new_egid));
3143 PERL_UNUSED_RESULT(setregid((Gid_t)-1, new_egid));
3145 #ifdef HAS_SETRESGID
3146 PERL_UNUSED_RESULT(setresgid((Gid_t)-1, new_egid, (Gid_t)-1));
3148 if (new_egid == PerlProc_getgid()) /* special case $) = $( */
3149 PERL_UNUSED_RESULT(PerlProc_setgid(new_egid));
3151 Perl_croak(aTHX_ "setegid() not implemented");
3159 PL_chopset = SvPV_force(sv,len);
3162 /* Store the pid in mg->mg_obj so we can tell when a fork has
3163 occurred. mg->mg_obj points to *$ by default, so clear it. */
3164 if (isGV(mg->mg_obj)) {
3165 if (mg->mg_flags & MGf_REFCOUNTED) /* probably never true */
3166 SvREFCNT_dec(mg->mg_obj);
3167 mg->mg_flags |= MGf_REFCOUNTED;
3168 mg->mg_obj = newSViv((IV)PerlProc_getpid());
3170 else sv_setiv(mg->mg_obj, (IV)PerlProc_getpid());
3173 LOCK_DOLLARZERO_MUTEX;
3174 S_set_dollarzero(aTHX_ sv);
3175 UNLOCK_DOLLARZERO_MUTEX;
3182 Perl_whichsig_sv(pTHX_ SV *sigsv)
3186 PERL_ARGS_ASSERT_WHICHSIG_SV;
3187 sigpv = SvPV_const(sigsv, siglen);
3188 return whichsig_pvn(sigpv, siglen);
3192 Perl_whichsig_pv(pTHX_ const char *sig)
3194 PERL_ARGS_ASSERT_WHICHSIG_PV;
3195 return whichsig_pvn(sig, strlen(sig));
3199 Perl_whichsig_pvn(pTHX_ const char *sig, STRLEN len)
3203 PERL_ARGS_ASSERT_WHICHSIG_PVN;
3204 PERL_UNUSED_CONTEXT;
3206 for (sigv = (char* const*)PL_sig_name; *sigv; sigv++)
3207 if (strlen(*sigv) == len && memEQ(sig,*sigv, len))
3208 return PL_sig_num[sigv - (char* const*)PL_sig_name];
3210 if (memEQs(sig, len, "CHLD"))
3214 if (memEQs(sig, len, "CLD"))
3221 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
3222 Perl_sighandler(int sig, siginfo_t *sip, void *uap)
3224 Perl_sighandler(int sig)
3227 #ifdef PERL_GET_SIG_CONTEXT
3228 dTHXa(PERL_GET_SIG_CONTEXT);
3235 SV * const tSv = PL_Sv;
3239 XPV * const tXpv = PL_Xpv;
3240 I32 old_ss_ix = PL_savestack_ix;
3241 SV *errsv_save = NULL;
3244 if (!PL_psig_ptr[sig]) {
3245 PerlIO_printf(Perl_error_log, "Signal SIG%s received, but no signal handler set.\n",
3250 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG) {
3251 /* Max number of items pushed there is 3*n or 4. We cannot fix
3252 infinity, so we fix 4 (in fact 5): */
3253 if (PL_savestack_ix + 15 <= PL_savestack_max) {
3255 PL_savestack_ix += 5; /* Protect save in progress. */
3256 SAVEDESTRUCTOR_X(S_unwind_handler_stack, NULL);
3259 /* sv_2cv is too complicated, try a simpler variant first: */
3260 if (!SvROK(PL_psig_ptr[sig]) || !(cv = MUTABLE_CV(SvRV(PL_psig_ptr[sig])))
3261 || SvTYPE(cv) != SVt_PVCV) {
3263 cv = sv_2cv(PL_psig_ptr[sig], &st, &gv, GV_ADD);
3266 if (!cv || !CvROOT(cv)) {
3267 const HEK * const hek = gv
3271 : cv && CvGV(cv) ? GvENAME_HEK(CvGV(cv)) : NULL;
3273 Perl_ck_warner(aTHX_ packWARN(WARN_SIGNAL),
3274 "SIG%s handler \"%" HEKf "\" not defined.\n",
3275 PL_sig_name[sig], HEKfARG(hek));
3276 /* diag_listed_as: SIG%s handler "%s" not defined */
3277 else Perl_ck_warner(aTHX_ packWARN(WARN_SIGNAL),
3278 "SIG%s handler \"__ANON__\" not defined.\n",
3283 sv = PL_psig_name[sig]
3284 ? SvREFCNT_inc_NN(PL_psig_name[sig])
3285 : newSVpv(PL_sig_name[sig],0);
3289 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG) {
3290 /* make sure our assumption about the size of the SAVEs are correct:
3291 * 3 for SAVEDESTRUCTOR_X, 2 for SAVEFREESV */
3292 assert(old_ss_ix + 2 + ((flags & 1) ? 3+5 : 0) == PL_savestack_ix);
3295 PUSHSTACKi(PERLSI_SIGNAL);
3298 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
3300 struct sigaction oact;
3302 if (sigaction(sig, 0, &oact) == 0 && oact.sa_flags & SA_SIGINFO) {
3305 SV *rv = newRV_noinc(MUTABLE_SV(sih));
3306 /* The siginfo fields signo, code, errno, pid, uid,
3307 * addr, status, and band are defined by POSIX/SUSv3. */
3308 (void)hv_stores(sih, "signo", newSViv(sip->si_signo));
3309 (void)hv_stores(sih, "code", newSViv(sip->si_code));
3310 #ifdef HAS_SIGINFO_SI_ERRNO
3311 (void)hv_stores(sih, "errno", newSViv(sip->si_errno));
3313 #ifdef HAS_SIGINFO_SI_STATUS
3314 (void)hv_stores(sih, "status", newSViv(sip->si_status));
3316 #ifdef HAS_SIGINFO_SI_UID
3319 sv_setuid(uid, sip->si_uid);
3320 (void)hv_stores(sih, "uid", uid);
3323 #ifdef HAS_SIGINFO_SI_PID
3324 (void)hv_stores(sih, "pid", newSViv(sip->si_pid));
3326 #ifdef HAS_SIGINFO_SI_ADDR
3327 (void)hv_stores(sih, "addr", newSVuv(PTR2UV(sip->si_addr)));
3329 #ifdef HAS_SIGINFO_SI_BAND
3330 (void)hv_stores(sih, "band", newSViv(sip->si_band));
3334 mPUSHp((char *)sip, sizeof(*sip));
3342 errsv_save = newSVsv(ERRSV);
3344 call_sv(MUTABLE_SV(cv), G_DISCARD|G_EVAL);
3348 SV * const errsv = ERRSV;
3349 if (SvTRUE_NN(errsv)) {
3350 SvREFCNT_dec(errsv_save);
3352 /* Handler "died", for example to get out of a restart-able read().
3353 * Before we re-do that on its behalf re-enable the signal which was
3354 * blocked by the system when we entered.
3356 #ifdef HAS_SIGPROCMASK
3357 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
3363 sigaddset(&set,sig);
3364 sigprocmask(SIG_UNBLOCK, &set, NULL);
3367 /* Not clear if this will work */
3368 (void)rsignal(sig, SIG_IGN);
3369 (void)rsignal(sig, PL_csighandlerp);
3371 #endif /* !PERL_MICRO */
3375 sv_setsv(errsv, errsv_save);
3376 SvREFCNT_dec(errsv_save);
3381 /* pop any of SAVEFREESV, SAVEDESTRUCTOR_X and "save in progress" */
3382 PL_savestack_ix = old_ss_ix;
3384 SvREFCNT_dec_NN(sv);
3385 PL_op = myop; /* Apparently not needed... */
3387 PL_Sv = tSv; /* Restore global temporaries. */
3394 S_restore_magic(pTHX_ const void *p)
3396 MGS* const mgs = SSPTR(PTR2IV(p), MGS*);
3397 SV* const sv = mgs->mgs_sv;
3403 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3404 SvTEMP_off(sv); /* if it's still magical, this value isn't temporary */
3406 SvFLAGS(sv) |= mgs->mgs_flags;
3411 bumped = mgs->mgs_bumped;
3412 mgs->mgs_sv = NULL; /* mark the MGS structure as restored */
3414 /* If we're still on top of the stack, pop us off. (That condition
3415 * will be satisfied if restore_magic was called explicitly, but *not*
3416 * if it's being called via leave_scope.)
3417 * The reason for doing this is that otherwise, things like sv_2cv()
3418 * may leave alloc gunk on the savestack, and some code
3419 * (e.g. sighandler) doesn't expect that...
3421 if (PL_savestack_ix == mgs->mgs_ss_ix)
3423 UV popval = SSPOPUV;
3424 assert(popval == SAVEt_DESTRUCTOR_X);
3425 PL_savestack_ix -= 2;
3427 assert((popval & SAVE_MASK) == SAVEt_ALLOC);
3428 PL_savestack_ix -= popval >> SAVE_TIGHT_SHIFT;
3431 if (SvREFCNT(sv) == 1) {
3432 /* We hold the last reference to this SV, which implies that the
3433 SV was deleted as a side effect of the routines we called.
3434 So artificially keep it alive a bit longer.
3435 We avoid turning on the TEMP flag, which can cause the SV's
3436 buffer to get stolen (and maybe other stuff). */
3441 SvREFCNT_dec_NN(sv); /* undo the inc in S_save_magic() */
3445 /* clean up the mess created by Perl_sighandler().
3446 * Note that this is only called during an exit in a signal handler;
3447 * a die is trapped by the call_sv() and the SAVEDESTRUCTOR_X manually
3451 S_unwind_handler_stack(pTHX_ const void *p)
3455 PL_savestack_ix -= 5; /* Unprotect save in progress. */
3459 =for apidoc magic_sethint
3461 Triggered by a store to C<%^H>, records the key/value pair to
3462 C<PL_compiling.cop_hints_hash>. It is assumed that hints aren't storing
3463 anything that would need a deep copy. Maybe we should warn if we find a
3469 Perl_magic_sethint(pTHX_ SV *sv, MAGIC *mg)
3471 SV *key = (mg->mg_len == HEf_SVKEY) ? MUTABLE_SV(mg->mg_ptr)
3472 : newSVpvn_flags(mg->mg_ptr, mg->mg_len, SVs_TEMP);
3474 PERL_ARGS_ASSERT_MAGIC_SETHINT;
3476 /* mg->mg_obj isn't being used. If needed, it would be possible to store
3477 an alternative leaf in there, with PL_compiling.cop_hints being used if
3478 it's NULL. If needed for threads, the alternative could lock a mutex,
3479 or take other more complex action. */
3481 /* Something changed in %^H, so it will need to be restored on scope exit.
3482 Doing this here saves a lot of doing it manually in perl code (and
3483 forgetting to do it, and consequent subtle errors. */
3484 PL_hints |= HINT_LOCALIZE_HH;
3485 CopHINTHASH_set(&PL_compiling,
3486 cophh_store_sv(CopHINTHASH_get(&PL_compiling), key, 0, sv, 0));
3491 =for apidoc magic_clearhint
3493 Triggered by a delete from C<%^H>, records the key to
3494 C<PL_compiling.cop_hints_hash>.
3499 Perl_magic_clearhint(pTHX_ SV *sv, MAGIC *mg)
3501 PERL_ARGS_ASSERT_MAGIC_CLEARHINT;
3502 PERL_UNUSED_ARG(sv);
3504 PL_hints |= HINT_LOCALIZE_HH;
3505 CopHINTHASH_set(&PL_compiling,
3506 mg->mg_len == HEf_SVKEY
3507 ? cophh_delete_sv(CopHINTHASH_get(&PL_compiling),
3508 MUTABLE_SV(mg->mg_ptr), 0, 0)
3509 : cophh_delete_pvn(CopHINTHASH_get(&PL_compiling),
3510 mg->mg_ptr, mg->mg_len, 0, 0));
3515 =for apidoc magic_clearhints
3517 Triggered by clearing C<%^H>, resets C<PL_compiling.cop_hints_hash>.
3522 Perl_magic_clearhints(pTHX_ SV *sv, MAGIC *mg)
3524 PERL_ARGS_ASSERT_MAGIC_CLEARHINTS;
3525 PERL_UNUSED_ARG(sv);
3526 PERL_UNUSED_ARG(mg);
3527 cophh_free(CopHINTHASH_get(&PL_compiling));
3528 CopHINTHASH_set(&PL_compiling, cophh_new_empty());
3533 Perl_magic_copycallchecker(pTHX_ SV *sv, MAGIC *mg, SV *nsv,
3534 const char *name, I32 namlen)
3538 PERL_ARGS_ASSERT_MAGIC_COPYCALLCHECKER;
3539 PERL_UNUSED_ARG(sv);
3540 PERL_UNUSED_ARG(name);
3541 PERL_UNUSED_ARG(namlen);
3543 sv_magic(nsv, &PL_sv_undef, mg->mg_type, NULL, 0);
3544 nmg = mg_find(nsv, mg->mg_type);
3546 if (nmg->mg_flags & MGf_REFCOUNTED) SvREFCNT_dec(nmg->mg_obj);
3547 nmg->mg_ptr = mg->mg_ptr;
3548 nmg->mg_obj = SvREFCNT_inc_simple(mg->mg_obj);
3549 nmg->mg_flags |= MGf_REFCOUNTED;
3554 Perl_magic_setdebugvar(pTHX_ SV *sv, MAGIC *mg) {
3555 PERL_ARGS_ASSERT_MAGIC_SETDEBUGVAR;
3557 #if DBVARMG_SINGLE != 0
3558 assert(mg->mg_private >= DBVARMG_SINGLE);
3560 assert(mg->mg_private < DBVARMG_COUNT);
3562 PL_DBcontrol[mg->mg_private] = SvIV_nomg(sv);
3568 Perl_magic_getdebugvar(pTHX_ SV *sv, MAGIC *mg) {
3569 PERL_ARGS_ASSERT_MAGIC_GETDEBUGVAR;
3571 #if DBVARMG_SINGLE != 0
3572 assert(mg->mg_private >= DBVARMG_SINGLE);
3574 assert(mg->mg_private < DBVARMG_COUNT);
3575 sv_setiv(sv, PL_DBcontrol[mg->mg_private]);
3581 * ex: set ts=8 sts=4 sw=4 et: