This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Change some =head1 to apidoc_section lines
[perl5.git] / mg.c
CommitLineData
a0d0e21e 1/* mg.c
79072805 2 *
1129b882
NC
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
79072805
LW
5 *
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
8 *
a0d0e21e
LW
9 */
10
11/*
4ac71550
TC
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.
14 *
15 * [p.363 of _The Lord of the Rings_, II/vii: "The Mirror of Galadriel"]
79072805
LW
16 */
17
ccfc67b7
JH
18/*
19=head1 Magical Functions
166f8a29
DM
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,
22an SV marked as magical, it calls the 'get' or 'set' function associated
154e47c8 23with that SV's magic. A get is called prior to reading an SV, in order to
ddfa107c 24give it a chance to update its internal value (get on $. writes the line
b53c43bf 25number of the last read filehandle into the SV's IV slot), while
166f8a29 26set is called after an SV has been written to, in order to allow it to make
ddfa107c 27use of its changed value (set on $/ copies the SV's new value to the
166f8a29
DM
28PL_rs global variable).
29
30Magic is implemented as a linked list of MAGIC structures attached to the
154e47c8 31SV. Each MAGIC struct holds the type of the magic, a pointer to an array
166f8a29 32of functions that implement the get(), set(), length() etc functions,
154e47c8 33plus space for some flags and pointers. For example, a tied variable has
166f8a29
DM
34a MAGIC structure that contains a pointer to the object associated with the
35tie.
36
7fefc6c1
KW
37=cut
38
ccfc67b7
JH
39*/
40
79072805 41#include "EXTERN.h"
864dbfa3 42#define PERL_IN_MG_C
79072805 43#include "perl.h"
b34c1a7e 44#include "feature.h"
79072805 45
5cd24f17 46#if defined(HAS_GETGROUPS) || defined(HAS_SETGROUPS)
b7953727
JH
47# ifdef I_GRP
48# include <grp.h>
49# endif
188ea221
CS
50#endif
51
757f63d8
SP
52#if defined(HAS_SETGROUPS)
53# ifndef NGROUPS
54# define NGROUPS 32
55# endif
56#endif
57
17aa7f3d
JH
58#ifdef __hpux
59# include <sys/pstat.h>
60#endif
61
7636ea95
AB
62#ifdef HAS_PRCTL_SET_NAME
63# include <sys/prctl.h>
64#endif
65
9cffb111
OS
66#ifdef __Lynx__
67/* Missing protos on LynxOS */
68void setruid(uid_t id);
69void seteuid(uid_t id);
70void setrgid(uid_t id);
71void setegid(uid_t id);
72#endif
73
c07a80fd 74/*
4bac9ae4 75 * Pre-magic setup and post-magic takedown.
c07a80fd
PP
76 * Use the "DESTRUCTOR" scope cleanup to reinstate magic.
77 */
78
79struct magic_state {
80 SV* mgs_sv;
455ece5e 81 I32 mgs_ss_ix;
a623f893 82 U32 mgs_flags;
150b625d 83 bool mgs_bumped;
c07a80fd 84};
455ece5e 85/* MGS is typedef'ed to struct magic_state in perl.h */
76e3520e
GS
86
87STATIC void
ff44333e 88S_save_magic_flags(pTHX_ I32 mgs_ix, SV *sv, U32 flags)
c07a80fd 89{
455ece5e 90 MGS* mgs;
150b625d 91 bool bumped = FALSE;
7918f24d 92
ff44333e 93 PERL_ARGS_ASSERT_SAVE_MAGIC_FLAGS;
7918f24d 94
4bac9ae4
CS
95 assert(SvMAGICAL(sv));
96
150b625d
DM
97 /* we shouldn't really be called here with RC==0, but it can sometimes
98 * happen via mg_clear() (which also shouldn't be called when RC==0,
99 * but it can happen). Handle this case gracefully(ish) by not RC++
100 * and thus avoiding the resultant double free */
101 if (SvREFCNT(sv) > 0) {
102 /* guard against sv getting freed midway through the mg clearing,
103 * by holding a private reference for the duration. */
104 SvREFCNT_inc_simple_void_NN(sv);
105 bumped = TRUE;
106 }
8985fe98 107
8772537c 108 SAVEDESTRUCTOR_X(S_restore_magic, INT2PTR(void*, (IV)mgs_ix));
455ece5e
AD
109
110 mgs = SSPTR(mgs_ix, MGS*);
c07a80fd 111 mgs->mgs_sv = sv;
a623f893 112 mgs->mgs_flags = SvMAGICAL(sv) | SvREADONLY(sv);
455ece5e 113 mgs->mgs_ss_ix = PL_savestack_ix; /* points after the saved destructor */
150b625d 114 mgs->mgs_bumped = bumped;
c07a80fd 115
ff44333e 116 SvFLAGS(sv) &= ~flags;
3805b5fb 117 SvREADONLY_off(sv);
c07a80fd
PP
118}
119
ff44333e
FC
120#define save_magic(a,b) save_magic_flags(a,b,SVs_GMG|SVs_SMG|SVs_RMG)
121
954c1994
GS
122/*
123=for apidoc mg_magical
124
fbe13c60 125Turns on the magical status of an SV. See C<L</sv_magic>>.
954c1994
GS
126
127=cut
128*/
129
8990e307 130void
ddeaf645 131Perl_mg_magical(SV *sv)
8990e307 132{
e1ec3a88 133 const MAGIC* mg;
7918f24d 134 PERL_ARGS_ASSERT_MG_MAGICAL;
f9c6fee5
CS
135
136 SvMAGICAL_off(sv);
218787bd 137 if ((mg = SvMAGIC(sv))) {
218787bd
VP
138 do {
139 const MGVTBL* const vtbl = mg->mg_virtual;
140 if (vtbl) {
141 if (vtbl->svt_get && !(mg->mg_flags & MGf_GSKIP))
142 SvGMAGICAL_on(sv);
143 if (vtbl->svt_set)
144 SvSMAGICAL_on(sv);
145 if (vtbl->svt_clear)
146 SvRMAGICAL_on(sv);
147 }
148 } while ((mg = mg->mg_moremagic));
149 if (!(SvFLAGS(sv) & (SVs_GMG|SVs_SMG)))
150 SvRMAGICAL_on(sv);
8990e307
LW
151 }
152}
153
954c1994
GS
154/*
155=for apidoc mg_get
156
4b1e7f06 157Do magic before a value is retrieved from the SV. The type of SV must
796b6530 158be >= C<SVt_PVMG>. See C<L</sv_magic>>.
954c1994
GS
159
160=cut
161*/
162
79072805 163int
864dbfa3 164Perl_mg_get(pTHX_ SV *sv)
79072805 165{
35a4481c 166 const I32 mgs_ix = SSNEW(sizeof(MGS));
a9844598 167 bool saved = FALSE;
f9c6fee5 168 bool have_new = 0;
b949b68f 169 bool taint_only = TRUE; /* the only get method seen is taint */
ff76feab 170 MAGIC *newmg, *head, *cur, *mg;
6683b158 171
7918f24d
NC
172 PERL_ARGS_ASSERT_MG_GET;
173
407287f9
FC
174 if (PL_localizing == 1 && sv == DEFSV) return 0;
175
ff76feab
AMS
176 /* We must call svt_get(sv, mg) for each valid entry in the linked
177 list of magic. svt_get() may delete the current entry, add new
178 magic to the head of the list, or upgrade the SV. AMS 20010810 */
179
180 newmg = cur = head = mg = SvMAGIC(sv);
181 while (mg) {
35a4481c 182 const MGVTBL * const vtbl = mg->mg_virtual;
f9c6fee5 183 MAGIC * const nextmg = mg->mg_moremagic; /* it may delete itself */
ff76feab 184
2b260de0 185 if (!(mg->mg_flags & MGf_GSKIP) && vtbl && vtbl->svt_get) {
a9844598
CS
186
187 /* taint's mg get is so dumb it doesn't need flag saving */
b949b68f
DM
188 if (mg->mg_type != PERL_MAGIC_taint) {
189 taint_only = FALSE;
190 if (!saved) {
191 save_magic(mgs_ix, sv);
192 saved = TRUE;
193 }
194 }
a9844598 195
16c91539 196 vtbl->svt_get(aTHX_ sv, mg);
b77f7d40 197
58f82c5c
DM
198 /* guard against magic having been deleted - eg FETCH calling
199 * untie */
f9c6fee5 200 if (!SvMAGIC(sv)) {
a623f893
FC
201 /* recalculate flags */
202 (SSPTR(mgs_ix, MGS *))->mgs_flags &= ~(SVs_GMG|SVs_SMG|SVs_RMG);
58f82c5c 203 break;
f9c6fee5 204 }
b77f7d40 205
f9c6fee5 206 /* recalculate flags if this entry was deleted. */
ff76feab 207 if (mg->mg_flags & MGf_GSKIP)
a623f893
FC
208 (SSPTR(mgs_ix, MGS *))->mgs_flags &=
209 ~(SVs_GMG|SVs_SMG|SVs_RMG);
a0d0e21e 210 }
7d1328bb 211 else if (vtbl == &PL_vtbl_utf8) {
b949b68f
DM
212 /* get-magic can reallocate the PV, unless there's only taint
213 * magic */
214 if (taint_only) {
215 MAGIC *mg2;
216 for (mg2 = nextmg; mg2; mg2 = mg2->mg_moremagic) {
217 if ( mg2->mg_type != PERL_MAGIC_taint
218 && !(mg2->mg_flags & MGf_GSKIP)
219 && mg2->mg_virtual
220 && mg2->mg_virtual->svt_get
221 ) {
222 taint_only = FALSE;
223 break;
224 }
225 }
226 }
227 if (!taint_only)
228 magic_setutf8(sv, mg);
7d1328bb 229 }
ff76feab 230
f9c6fee5 231 mg = nextmg;
ff76feab 232
0723351e 233 if (have_new) {
ff76feab
AMS
234 /* Have we finished with the new entries we saw? Start again
235 where we left off (unless there are more new entries). */
236 if (mg == head) {
0723351e 237 have_new = 0;
ff76feab
AMS
238 mg = cur;
239 head = newmg;
240 }
241 }
242
243 /* Were any new entries added? */
0723351e
NC
244 if (!have_new && (newmg = SvMAGIC(sv)) != head) {
245 have_new = 1;
ff76feab
AMS
246 cur = mg;
247 mg = newmg;
a623f893
FC
248 /* recalculate flags */
249 (SSPTR(mgs_ix, MGS *))->mgs_flags &= ~(SVs_GMG|SVs_SMG|SVs_RMG);
760ac839 250 }
79072805 251 }
463ee0b2 252
a9844598
CS
253 if (saved)
254 restore_magic(INT2PTR(void *, (IV)mgs_ix));
255
79072805
LW
256 return 0;
257}
258
954c1994
GS
259/*
260=for apidoc mg_set
261
fbe13c60 262Do magic after a value is assigned to the SV. See C<L</sv_magic>>.
954c1994
GS
263
264=cut
265*/
266
79072805 267int
864dbfa3 268Perl_mg_set(pTHX_ SV *sv)
79072805 269{
35a4481c 270 const I32 mgs_ix = SSNEW(sizeof(MGS));
79072805 271 MAGIC* mg;
463ee0b2
LW
272 MAGIC* nextmg;
273
7918f24d
NC
274 PERL_ARGS_ASSERT_MG_SET;
275
b5ed8c44
FC
276 if (PL_localizing == 2 && sv == DEFSV) return 0;
277
ff44333e 278 save_magic_flags(mgs_ix, sv, SVs_GMG|SVs_SMG); /* leave SVs_RMG on */
463ee0b2
LW
279
280 for (mg = SvMAGIC(sv); mg; mg = nextmg) {
e1ec3a88 281 const MGVTBL* vtbl = mg->mg_virtual;
463ee0b2 282 nextmg = mg->mg_moremagic; /* it may delete itself */
a0d0e21e
LW
283 if (mg->mg_flags & MGf_GSKIP) {
284 mg->mg_flags &= ~MGf_GSKIP; /* setting requires another read */
a623f893 285 (SSPTR(mgs_ix, MGS*))->mgs_flags &= ~(SVs_GMG|SVs_SMG|SVs_RMG);
a0d0e21e 286 }
e0a73de4 287 if (PL_localizing == 2
b5ed8c44 288 && PERL_MAGIC_TYPE_IS_VALUE_MAGIC(mg->mg_type))
e7cbf6c6 289 continue;
2b260de0 290 if (vtbl && vtbl->svt_set)
16c91539 291 vtbl->svt_set(aTHX_ sv, mg);
79072805 292 }
463ee0b2 293
8772537c 294 restore_magic(INT2PTR(void*, (IV)mgs_ix));
79072805
LW
295 return 0;
296}
297
954c1994
GS
298/*
299=for apidoc mg_length
300
d4e99c76 301Reports on the SV's length in bytes, calling length magic if available,
796b6530 302but does not set the UTF8 flag on C<sv>. It will fall back to 'get'
bd8446cf 303magic if there is no 'length' magic, but with no indication as to
796b6530
KW
304whether it called 'get' magic. It assumes C<sv> is a C<PVMG> or
305higher. Use C<sv_len()> instead.
954c1994
GS
306
307=cut
308*/
309
79072805 310U32
864dbfa3 311Perl_mg_length(pTHX_ SV *sv)
79072805
LW
312{
313 MAGIC* mg;
463ee0b2 314 STRLEN len;
463ee0b2 315
7918f24d
NC
316 PERL_ARGS_ASSERT_MG_LENGTH;
317
79072805 318 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
35a4481c 319 const MGVTBL * const vtbl = mg->mg_virtual;
2b260de0 320 if (vtbl && vtbl->svt_len) {
35a4481c 321 const I32 mgs_ix = SSNEW(sizeof(MGS));
455ece5e 322 save_magic(mgs_ix, sv);
a0d0e21e 323 /* omit MGf_GSKIP -- not changed here */
16c91539 324 len = vtbl->svt_len(aTHX_ sv, mg);
8772537c 325 restore_magic(INT2PTR(void*, (IV)mgs_ix));
85e6fe83
LW
326 return len;
327 }
328 }
329
bd8446cf 330 (void)SvPV_const(sv, len);
463ee0b2 331 return len;
79072805
LW
332}
333
8fb26106 334I32
864dbfa3 335Perl_mg_size(pTHX_ SV *sv)
93965878
NIS
336{
337 MAGIC* mg;
ac27b0f5 338
7918f24d
NC
339 PERL_ARGS_ASSERT_MG_SIZE;
340
93965878 341 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
35a4481c 342 const MGVTBL* const vtbl = mg->mg_virtual;
2b260de0 343 if (vtbl && vtbl->svt_len) {
35a4481c
AL
344 const I32 mgs_ix = SSNEW(sizeof(MGS));
345 I32 len;
455ece5e 346 save_magic(mgs_ix, sv);
93965878 347 /* omit MGf_GSKIP -- not changed here */
16c91539 348 len = vtbl->svt_len(aTHX_ sv, mg);
8772537c 349 restore_magic(INT2PTR(void*, (IV)mgs_ix));
93965878
NIS
350 return len;
351 }
352 }
353
354 switch(SvTYPE(sv)) {
355 case SVt_PVAV:
502c6561 356 return AvFILLp((const AV *) sv); /* Fallback to non-tied array */
93965878
NIS
357 case SVt_PVHV:
358 /* FIXME */
359 default:
cea2e8a9 360 Perl_croak(aTHX_ "Size magic not implemented");
81d52ecd 361
93965878 362 }
a25b5927 363 NOT_REACHED; /* NOTREACHED */
93965878
NIS
364}
365
954c1994
GS
366/*
367=for apidoc mg_clear
368
fbe13c60 369Clear something magical that the SV represents. See C<L</sv_magic>>.
954c1994
GS
370
371=cut
372*/
373
79072805 374int
864dbfa3 375Perl_mg_clear(pTHX_ SV *sv)
79072805 376{
35a4481c 377 const I32 mgs_ix = SSNEW(sizeof(MGS));
79072805 378 MAGIC* mg;
8ac77ac9 379 MAGIC *nextmg;
463ee0b2 380
7918f24d
NC
381 PERL_ARGS_ASSERT_MG_CLEAR;
382
455ece5e 383 save_magic(mgs_ix, sv);
463ee0b2 384
8ac77ac9 385 for (mg = SvMAGIC(sv); mg; mg = nextmg) {
35a4481c 386 const MGVTBL* const vtbl = mg->mg_virtual;
a0d0e21e 387 /* omit GSKIP -- never set here */
727405f8 388
8ac77ac9
NC
389 nextmg = mg->mg_moremagic; /* it may delete itself */
390
2b260de0 391 if (vtbl && vtbl->svt_clear)
16c91539 392 vtbl->svt_clear(aTHX_ sv, mg);
79072805 393 }
463ee0b2 394
8772537c 395 restore_magic(INT2PTR(void*, (IV)mgs_ix));
79072805
LW
396 return 0;
397}
398
ed624ca8 399static MAGIC*
ddeaf645 400S_mg_findext_flags(const SV *sv, int type, const MGVTBL *vtbl, U32 flags)
39de7f53 401{
39de7f53
FR
402 assert(flags <= 1);
403
404 if (sv) {
405 MAGIC *mg;
406
407 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
408 if (mg->mg_type == type && (!flags || mg->mg_virtual == vtbl)) {
409 return mg;
410 }
411 }
412 }
413
414 return NULL;
415}
416
954c1994
GS
417/*
418=for apidoc mg_find
419
796b6530 420Finds the magic pointer for C<type> matching the SV. See C<L</sv_magic>>.
954c1994
GS
421
422=cut
423*/
424
93a17b20 425MAGIC*
ddeaf645 426Perl_mg_find(const SV *sv, int type)
93a17b20 427{
ddeaf645 428 return S_mg_findext_flags(sv, type, NULL, 0);
39de7f53
FR
429}
430
431/*
432=for apidoc mg_findext
433
434Finds the magic pointer of C<type> with the given C<vtbl> for the C<SV>. See
fbe13c60 435C<L</sv_magicext>>.
39de7f53
FR
436
437=cut
438*/
439
440MAGIC*
ddeaf645 441Perl_mg_findext(const SV *sv, int type, const MGVTBL *vtbl)
39de7f53 442{
ddeaf645 443 return S_mg_findext_flags(sv, type, vtbl, 1);
93a17b20
LW
444}
445
96c2a8ff
FC
446MAGIC *
447Perl_mg_find_mglob(pTHX_ SV *sv)
448{
449 PERL_ARGS_ASSERT_MG_FIND_MGLOB;
450 if (SvTYPE(sv) == SVt_PVLV && LvTYPE(sv) == 'y') {
451 /* This sv is only a delegate. //g magic must be attached to
452 its target. */
453 vivify_defelem(sv);
454 sv = LvTARG(sv);
455 }
456 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv))
ddeaf645 457 return S_mg_findext_flags(sv, PERL_MAGIC_regex_global, 0, 0);
96c2a8ff
FC
458 return NULL;
459}
460
954c1994
GS
461/*
462=for apidoc mg_copy
463
fbe13c60 464Copies the magic from one SV to another. See C<L</sv_magic>>.
954c1994
GS
465
466=cut
467*/
468
79072805 469int
864dbfa3 470Perl_mg_copy(pTHX_ SV *sv, SV *nsv, const char *key, I32 klen)
79072805 471{
463ee0b2 472 int count = 0;
79072805 473 MAGIC* mg;
7918f24d
NC
474
475 PERL_ARGS_ASSERT_MG_COPY;
476
463ee0b2 477 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
35a4481c 478 const MGVTBL* const vtbl = mg->mg_virtual;
68795e93 479 if ((mg->mg_flags & MGf_COPY) && vtbl->svt_copy){
16c91539 480 count += vtbl->svt_copy(aTHX_ sv, mg, nsv, key, klen);
68795e93 481 }
823a54a3
AL
482 else {
483 const char type = mg->mg_type;
1e73acc8 484 if (isUPPER(type) && type != PERL_MAGIC_uvar) {
823a54a3
AL
485 sv_magic(nsv,
486 (type == PERL_MAGIC_tied)
487 ? SvTIED_obj(sv, mg)
27deb0cf 488 : mg->mg_obj,
823a54a3
AL
489 toLOWER(type), key, klen);
490 count++;
491 }
79072805 492 }
79072805 493 }
463ee0b2 494 return count;
79072805
LW
495}
496
954c1994 497/*
0cbee0a4
DM
498=for apidoc mg_localize
499
9711599e 500Copy some of the magic from an existing SV to new localized version of that
dfcfced8
KW
501SV. Container magic (I<e.g.>, C<%ENV>, C<$1>, C<tie>)
502gets copied, value magic doesn't (I<e.g.>,
796b6530 503C<taint>, C<pos>).
9711599e 504
796b6530 505If C<setmagic> is false then no set magic will be called on the new (empty) SV.
61b16eb9 506This typically means that assignment will soon follow (e.g. S<C<'local $x = $y'>>),
9711599e 507and that will handle the magic.
0cbee0a4
DM
508
509=cut
510*/
511
512void
af7df257 513Perl_mg_localize(pTHX_ SV *sv, SV *nsv, bool setmagic)
0cbee0a4
DM
514{
515 MAGIC *mg;
7918f24d
NC
516
517 PERL_ARGS_ASSERT_MG_LOCALIZE;
518
658a9f31
JD
519 if (nsv == DEFSV)
520 return;
521
0cbee0a4 522 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
2b1b43ea 523 const MGVTBL* const vtbl = mg->mg_virtual;
e0a73de4 524 if (PERL_MAGIC_TYPE_IS_VALUE_MAGIC(mg->mg_type))
0cbee0a4 525 continue;
0cbee0a4 526
a5063e7c 527 if ((mg->mg_flags & MGf_LOCAL) && vtbl->svt_local)
16c91539 528 (void)vtbl->svt_local(aTHX_ nsv, mg);
a5063e7c 529 else
0cbee0a4
DM
530 sv_magicext(nsv, mg->mg_obj, mg->mg_type, vtbl,
531 mg->mg_ptr, mg->mg_len);
a5063e7c 532
0cbee0a4 533 /* container types should remain read-only across localization */
9ff3e6d8 534 SvFLAGS(nsv) |= SvREADONLY(sv);
0cbee0a4
DM
535 }
536
537 if (SvTYPE(nsv) >= SVt_PVMG && SvMAGIC(nsv)) {
538 SvFLAGS(nsv) |= SvMAGICAL(sv);
af7df257 539 if (setmagic) {
9711599e
CS
540 PL_localizing = 1;
541 SvSETMAGIC(nsv);
542 PL_localizing = 0;
543 }
0cbee0a4
DM
544 }
545}
546
d9088386
Z
547#define mg_free_struct(sv, mg) S_mg_free_struct(aTHX_ sv, mg)
548static void
549S_mg_free_struct(pTHX_ SV *sv, MAGIC *mg)
550{
551 const MGVTBL* const vtbl = mg->mg_virtual;
552 if (vtbl && vtbl->svt_free)
553 vtbl->svt_free(aTHX_ sv, mg);
44955e7d
DM
554
555 if (mg->mg_type == PERL_MAGIC_collxfrm && mg->mg_len >= 0)
556 /* collate magic uses string len not buffer len, so
557 * free even with mg_len == 0 */
558 Safefree(mg->mg_ptr);
559 else if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
d9088386
Z
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));
564 }
44955e7d 565
d9088386
Z
566 if (mg->mg_flags & MGf_REFCOUNTED)
567 SvREFCNT_dec(mg->mg_obj);
568 Safefree(mg);
569}
570
0cbee0a4 571/*
954c1994
GS
572=for apidoc mg_free
573
fbe13c60 574Free any magic storage used by the SV. See C<L</sv_magic>>.
954c1994
GS
575
576=cut
577*/
578
79072805 579int
864dbfa3 580Perl_mg_free(pTHX_ SV *sv)
79072805
LW
581{
582 MAGIC* mg;
583 MAGIC* moremagic;
7918f24d
NC
584
585 PERL_ARGS_ASSERT_MG_FREE;
586
79072805 587 for (mg = SvMAGIC(sv); mg; mg = moremagic) {
79072805 588 moremagic = mg->mg_moremagic;
d9088386 589 mg_free_struct(sv, mg);
c826f41b 590 SvMAGIC_set(sv, moremagic);
79072805 591 }
b162af07 592 SvMAGIC_set(sv, NULL);
68f8932e 593 SvMAGICAL_off(sv);
79072805
LW
594 return 0;
595}
596
d9088386 597/*
44170c9a 598=for apidoc mg_free_type
d9088386 599
2d7f6611 600Remove any magic of type C<how> from the SV C<sv>. See L</sv_magic>.
d9088386
Z
601
602=cut
603*/
604
605void
606Perl_mg_free_type(pTHX_ SV *sv, int how)
607{
608 MAGIC *mg, *prevmg, *moremg;
609 PERL_ARGS_ASSERT_MG_FREE_TYPE;
610 for (prevmg = NULL, mg = SvMAGIC(sv); mg; prevmg = mg, mg = moremg) {
d9088386
Z
611 moremg = mg->mg_moremagic;
612 if (mg->mg_type == how) {
19742f39 613 MAGIC *newhead;
d9088386
Z
614 /* temporarily move to the head of the magic chain, in case
615 custom free code relies on this historical aspect of mg_free */
616 if (prevmg) {
617 prevmg->mg_moremagic = moremg;
618 mg->mg_moremagic = SvMAGIC(sv);
619 SvMAGIC_set(sv, mg);
620 }
621 newhead = mg->mg_moremagic;
622 mg_free_struct(sv, mg);
623 SvMAGIC_set(sv, newhead);
624 mg = prevmg;
625 }
626 }
627 mg_magical(sv);
628}
629
e0d4aead
TC
630/*
631=for apidoc mg_freeext
632
633Remove any magic of type C<how> using virtual table C<vtbl> from the
634SV C<sv>. See L</sv_magic>.
635
636C<mg_freeext(sv, how, NULL)> is equivalent to C<mg_free_type(sv, how)>.
637
638=cut
639*/
640
641void
642Perl_mg_freeext(pTHX_ SV *sv, int how, const MGVTBL *vtbl)
643{
644 MAGIC *mg, *prevmg, *moremg;
645 PERL_ARGS_ASSERT_MG_FREEEXT;
646 for (prevmg = NULL, mg = SvMAGIC(sv); mg; prevmg = mg, mg = moremg) {
647 MAGIC *newhead;
648 moremg = mg->mg_moremagic;
649 if (mg->mg_type == how && (vtbl == NULL || mg->mg_virtual == vtbl)) {
650 /* temporarily move to the head of the magic chain, in case
651 custom free code relies on this historical aspect of mg_free */
652 if (prevmg) {
653 prevmg->mg_moremagic = moremg;
654 mg->mg_moremagic = SvMAGIC(sv);
655 SvMAGIC_set(sv, mg);
656 }
657 newhead = mg->mg_moremagic;
658 mg_free_struct(sv, mg);
659 SvMAGIC_set(sv, newhead);
660 mg = prevmg;
661 }
662 }
663 mg_magical(sv);
664}
665
79072805 666#include <signal.h>
79072805 667
942e002e 668U32
864dbfa3 669Perl_magic_regdata_cnt(pTHX_ SV *sv, MAGIC *mg)
6cef1e77 670{
8772537c 671 PERL_UNUSED_ARG(sv);
6cef1e77 672
7918f24d
NC
673 PERL_ARGS_ASSERT_MAGIC_REGDATA_CNT;
674
0bd48802 675 if (PL_curpm) {
27deb0cf 676 REGEXP * const rx = PM_GETRE(PL_curpm);
0bd48802 677 if (rx) {
fa531f32
DM
678 const SSize_t n = (SSize_t)mg->mg_obj;
679 if (n == '+') { /* @+ */
a678b0e4 680 /* return the number possible */
07bc277f 681 return RX_NPARENS(rx);
27deb0cf 682 } else { /* @- @^CAPTURE @{^CAPTURE} */
07bc277f 683 I32 paren = RX_LASTPAREN(rx);
a678b0e4
YO
684
685 /* return the last filled */
f46c4081 686 while ( paren >= 0
07bc277f
NC
687 && (RX_OFFS(rx)[paren].start == -1
688 || RX_OFFS(rx)[paren].end == -1) )
f46c4081 689 paren--;
fa531f32 690 if (n == '-') {
27deb0cf
YO
691 /* @- */
692 return (U32)paren;
693 } else {
694 /* @^CAPTURE @{^CAPTURE} */
695 return paren >= 0 ? (U32)(paren-1) : (U32)-1;
696 }
697 }
0bd48802 698 }
8f580fb8 699 }
ac27b0f5 700
942e002e 701 return (U32)-1;
6cef1e77
IZ
702}
703
6502e081
DM
704/* @-, @+ */
705
6cef1e77 706int
864dbfa3 707Perl_magic_regdatum_get(pTHX_ SV *sv, MAGIC *mg)
6cef1e77 708{
7918f24d
NC
709 PERL_ARGS_ASSERT_MAGIC_REGDATUM_GET;
710
0bd48802 711 if (PL_curpm) {
27deb0cf 712 REGEXP * const rx = PM_GETRE(PL_curpm);
0bd48802 713 if (rx) {
fa531f32 714 const SSize_t n = (SSize_t)mg->mg_obj;
27deb0cf
YO
715 /* @{^CAPTURE} does not contain $&, so we need to increment by 1 */
716 const I32 paren = mg->mg_len
fa531f32 717 + (n == '\003' ? 1 : 0);
a10eae29
FC
718 SSize_t s;
719 SSize_t t;
0bd48802
AL
720 if (paren < 0)
721 return 0;
07bc277f
NC
722 if (paren <= (I32)RX_NPARENS(rx) &&
723 (s = RX_OFFS(rx)[paren].start) != -1 &&
724 (t = RX_OFFS(rx)[paren].end) != -1)
0bd48802 725 {
a10eae29 726 SSize_t i;
27deb0cf 727
fa531f32 728 if (n == '+') /* @+ */
0bd48802 729 i = t;
fa531f32 730 else if (n == '-') /* @- */
0bd48802 731 i = s;
27deb0cf
YO
732 else { /* @^CAPTURE @{^CAPTURE} */
733 CALLREG_NUMBUF_FETCH(rx,paren,sv);
734 return 0;
735 }
0bd48802 736
a10eae29 737 if (RX_MATCH_UTF8(rx)) {
07bc277f 738 const char * const b = RX_SUBBEG(rx);
0bd48802 739 if (b)
6502e081
DM
740 i = RX_SUBCOFFSET(rx) +
741 utf8_length((U8*)b,
742 (U8*)(b-RX_SUBOFFSET(rx)+i));
0bd48802 743 }
727405f8 744
a10eae29 745 sv_setuv(sv, i);
232af1f8 746 return 0;
1aa99e6b 747 }
0bd48802 748 }
6cef1e77 749 }
3773545d 750 sv_set_undef(sv);
6cef1e77
IZ
751 return 0;
752}
753
6502e081
DM
754/* @-, @+ */
755
e4b89193 756int
a29d06ed
MG
757Perl_magic_regdatum_set(pTHX_ SV *sv, MAGIC *mg)
758{
7918f24d 759 PERL_ARGS_ASSERT_MAGIC_REGDATUM_SET;
dc3bf405 760 PERL_UNUSED_CONTEXT;
d4c19fe8
AL
761 PERL_UNUSED_ARG(sv);
762 PERL_UNUSED_ARG(mg);
cb077ed2 763 Perl_croak_no_modify();
0dbb1585 764 NORETURN_FUNCTION_END;
a29d06ed
MG
765}
766
ad3296c6 767#define SvRTRIM(sv) STMT_START { \
eae92ea0
GA
768 if (SvPOK(sv)) { \
769 STRLEN len = SvCUR(sv); \
770 char * const p = SvPVX(sv); \
8e6b4db6
PC
771 while (len > 0 && isSPACE(p[len-1])) \
772 --len; \
773 SvCUR_set(sv, len); \
774 p[len] = '\0'; \
775 } \
ad3296c6
SH
776} STMT_END
777
8b850bd5
NC
778void
779Perl_emulate_cop_io(pTHX_ const COP *const c, SV *const sv)
780{
7918f24d
NC
781 PERL_ARGS_ASSERT_EMULATE_COP_IO;
782
8b850bd5 783 if (!(CopHINTS_get(c) & (HINT_LEXICAL_IO_IN|HINT_LEXICAL_IO_OUT)))
e03e82a0 784 sv_set_undef(sv);
8b850bd5 785 else {
b2aed775 786 SvPVCLEAR(sv);
8b850bd5
NC
787 SvUTF8_off(sv);
788 if ((CopHINTS_get(c) & HINT_LEXICAL_IO_IN)) {
20439bc7 789 SV *const value = cop_hints_fetch_pvs(c, "open<", 0);
8b850bd5
NC
790 assert(value);
791 sv_catsv(sv, value);
792 }
793 sv_catpvs(sv, "\0");
794 if ((CopHINTS_get(c) & HINT_LEXICAL_IO_OUT)) {
20439bc7 795 SV *const value = cop_hints_fetch_pvs(c, "open>", 0);
8b850bd5
NC
796 assert(value);
797 sv_catsv(sv, value);
798 }
799 }
800}
801
d9fe7d23
KW
802STATIC void
803S_fixup_errno_string(pTHX_ SV* sv)
804{
805 /* Do what is necessary to fixup the non-empty string in 'sv' for return to
806 * Perl space. */
807
808 PERL_ARGS_ASSERT_FIXUP_ERRNO_STRING;
809
810 assert(SvOK(sv));
b35e4f8b
KW
811
812 if(strEQ(SvPVX(sv), "")) {
813 sv_catpv(sv, UNKNOWN_ERRNO_MSG);
814 }
815 else {
d9fe7d23 816
d3c0b317
KW
817 /* In some locales the error string may come back as UTF-8, in which
818 * case we should turn on that flag. This didn't use to happen, and to
5320b60d
KW
819 * avoid as many possible backward compatibility issues as possible, we
820 * don't turn on the flag unless we have to. So the flag stays off for
9f10db87 821 * an entirely invariant string. We assume that if the string looks
fab19207
KW
822 * like UTF-8 in a single script, it really is UTF-8: "text in any
823 * other encoding that uses bytes with the high bit set is extremely
824 * unlikely to pass a UTF-8 validity test"
9f10db87
KW
825 * (http://en.wikipedia.org/wiki/Charset_detection). There is a
826 * potential that we will get it wrong however, especially on short
a8f4b0c6 827 * error message text, so do an additional check. */
027a0d26
KW
828 if ( ! IN_BYTES /* respect 'use bytes' */
829 && is_utf8_non_invariant_string((U8*) SvPVX_const(sv), SvCUR(sv))
a8f4b0c6
KW
830
831#ifdef USE_LOCALE_MESSAGES
832
61520eee 833 && _is_cur_LC_category_utf8(LC_MESSAGES)
a8f4b0c6 834
fab19207
KW
835#else /* If can't check directly, at least can see if script is consistent,
836 under UTF-8, which gives us an extra measure of confidence. */
837
838 && isSCRIPT_RUN((const U8 *) SvPVX_const(sv), (U8 *) SvEND(sv),
8c53dada 839 TRUE) /* Means assume UTF-8 */
a8f4b0c6
KW
840#endif
841
842 ) {
d3c0b317
KW
843 SvUTF8_on(sv);
844 }
b35e4f8b 845 }
d9fe7d23
KW
846}
847
658db622 848/*
44170c9a 849=for apidoc sv_string_from_errnum
658db622
Z
850
851Generates the message string describing an OS error and returns it as
852an SV. C<errnum> must be a value that C<errno> could take, identifying
853the type of error.
854
855If C<tgtsv> is non-null then the string will be written into that SV
856(overwriting existing content) and it will be returned. If C<tgtsv>
857is a null pointer then the string will be written into a new mortal SV
858which will be returned.
859
860The message will be taken from whatever locale would be used by C<$!>,
861and will be encoded in the SV in whatever manner would be used by C<$!>.
862The details of this process are subject to future change. Currently,
863the message is taken from the C locale by default (usually producing an
864English message), and from the currently selected locale when in the scope
865of the C<use locale> pragma. A heuristic attempt is made to decode the
866message from the locale's character encoding, but it will only be decoded
867as either UTF-8 or ISO-8859-1. It is always correctly decoded in a UTF-8
868locale, usually in an ISO-8859-1 locale, and never in any other locale.
869
870The SV is always returned containing an actual string, and with no other
871OK bits set. Unlike C<$!>, a message is even yielded for C<errnum> zero
872(meaning success), and if no useful message is available then a useless
873string (currently empty) is returned.
874
875=cut
876*/
877
878SV *
879Perl_sv_string_from_errnum(pTHX_ int errnum, SV *tgtsv)
880{
881 char const *errstr;
882 if(!tgtsv)
883 tgtsv = sv_newmortal();
884 errstr = my_strerror(errnum);
885 if(errstr) {
886 sv_setpv(tgtsv, errstr);
887 fixup_errno_string(tgtsv);
888 } else {
889 SvPVCLEAR(tgtsv);
890 }
891 return tgtsv;
892}
893
25bbd826
CB
894#ifdef VMS
895#include <descrip.h>
896#include <starlet.h>
897#endif
898
79072805 899int
864dbfa3 900Perl_magic_get(pTHX_ SV *sv, MAGIC *mg)
79072805 901{
eb578fdb
KW
902 I32 paren;
903 const char *s = NULL;
904 REGEXP *rx;
823a54a3 905 const char * const remaining = mg->mg_ptr + 1;
e91d8259 906 char nextchar;
79072805 907
7918f24d
NC
908 PERL_ARGS_ASSERT_MAGIC_GET;
909
e91d8259 910 if (!mg->mg_ptr) {
e91d8259 911 paren = mg->mg_len;
e91d8259 912 if (PL_curpm && (rx = PM_GETRE(PL_curpm))) {
a6d0b1b5 913 do_numbuf_fetch:
e91d8259 914 CALLREG_NUMBUF_FETCH(rx,paren,sv);
e91d8259 915 }
e03e82a0
DM
916 else
917 goto set_undef;
e91d8259
NC
918 return 0;
919 }
920
921 nextchar = *remaining;
79072805 922 switch (*mg->mg_ptr) {
748a9306 923 case '\001': /* ^A */
f2da823f 924 if (SvOK(PL_bodytarget)) sv_copypv(sv, PL_bodytarget);
e03e82a0
DM
925 else
926 sv_set_undef(sv);
125b9982
NT
927 if (SvTAINTED(PL_bodytarget))
928 SvTAINTED_on(sv);
748a9306 929 break;
e5218da5 930 case '\003': /* ^C, ^CHILD_ERROR_NATIVE */
823a54a3 931 if (nextchar == '\0') {
e5218da5
GA
932 sv_setiv(sv, (IV)PL_minus_c);
933 }
823a54a3 934 else if (strEQ(remaining, "HILD_ERROR_NATIVE")) {
e5218da5
GA
935 sv_setiv(sv, (IV)STATUS_NATIVE);
936 }
49460fe6
NIS
937 break;
938
79072805 939 case '\004': /* ^D */
aea4f609 940 sv_setiv(sv, (IV)(PL_debug & DEBUG_MASK));
79072805 941 break;
28f23441 942 case '\005': /* ^E */
6c6eab55
KW
943 if (nextchar != '\0') {
944 if (strEQ(remaining, "NCODING"))
3773545d 945 sv_set_undef(sv);
4f4ff3a7 946 break;
6c6eab55 947 }
4f4ff3a7
KW
948
949#if defined(VMS) || defined(OS2) || defined(WIN32)
950# if defined(VMS)
2a99ff86
KW
951 {
952 char msg[255];
953 $DESCRIPTOR(msgdsc,msg);
954 sv_setnv(sv,(NV) vaxc$errno);
955 if (sys$getmsg(vaxc$errno,&msgdsc.dsc$w_length,&msgdsc,0,0) & 1)
956 sv_setpvn(sv,msgdsc.dsc$a_pointer,msgdsc.dsc$w_length);
957 else
b2aed775 958 SvPVCLEAR(sv);
2a99ff86 959 }
4b645107 960#elif defined(OS2)
2a99ff86
KW
961 if (!(_emx_env & 0x200)) { /* Under DOS */
962 sv_setnv(sv, (NV)errno);
2c6ee1a7 963 sv_setpv(sv, errno ? my_strerror(errno) : "");
2a99ff86
KW
964 } else {
965 if (errno != errno_isOS2) {
966 const int tmp = _syserrno();
967 if (tmp) /* 2nd call to _syserrno() makes it 0 */
968 Perl_rc = tmp;
969 }
970 sv_setnv(sv, (NV)Perl_rc);
971 sv_setpv(sv, os2error(Perl_rc));
972 }
1534c6f5 973 if (SvOK(sv) && strNE(SvPVX(sv), "")) {
99461a73
KW
974 fixup_errno_string(sv);
975 }
4f4ff3a7 976# elif defined(WIN32)
2a99ff86
KW
977 {
978 const DWORD dwErr = GetLastError();
979 sv_setnv(sv, (NV)dwErr);
980 if (dwErr) {
981 PerlProc_GetOSError(sv, dwErr);
2efab60d 982 fixup_errno_string(sv);
2a99ff86
KW
983 }
984 else
b2aed775 985 SvPVCLEAR(sv);
2a99ff86
KW
986 SetLastError(dwErr);
987 }
4f4ff3a7
KW
988# else
989# error Missing code for platform
990# endif
2a99ff86
KW
991 SvRTRIM(sv);
992 SvNOK_on(sv); /* what a wonderful hack! */
993 break;
4f4ff3a7
KW
994#endif /* End of platforms with special handling for $^E; others just fall
995 through to $! */
2165bd23 996 /* FALLTHROUGH */
46f3e16c
KW
997
998 case '!':
999 {
5f1b979d 1000 dSAVE_ERRNO;
46f3e16c 1001#ifdef VMS
5f1b979d 1002 sv_setnv(sv, (NV)((errno == EVMSERR) ? vaxc$errno : errno));
46f3e16c 1003#else
5f1b979d 1004 sv_setnv(sv, (NV)errno);
46f3e16c
KW
1005#endif
1006#ifdef OS2
5f1b979d
KW
1007 if (errno == errno_isOS2 || errno == errno_isOS2_set)
1008 sv_setpv(sv, os2error(Perl_rc));
1009 else
46f3e16c 1010#endif
5f1b979d 1011 if (! errno) {
b2aed775 1012 SvPVCLEAR(sv);
46f3e16c 1013 }
5f1b979d 1014 else {
658db622
Z
1015 sv_string_from_errnum(errno, sv);
1016 /* If no useful string is available, don't
1017 * claim to have a string part. The SvNOK_on()
5f1b979d 1018 * below will cause just the number part to be valid */
658db622
Z
1019 if (!SvCUR(sv))
1020 SvPOK_off(sv);
5f1b979d
KW
1021 }
1022 RESTORE_ERRNO;
46f3e16c
KW
1023 }
1024
1025 SvRTRIM(sv);
1026 SvNOK_on(sv); /* what a wonderful hack! */
1027 break;
1028
79072805 1029 case '\006': /* ^F */
9f601cf3
TC
1030 if (nextchar == '\0') {
1031 sv_setiv(sv, (IV)PL_maxsysfd);
1032 }
79072805 1033 break;
9ebf26ad
FR
1034 case '\007': /* ^GLOBAL_PHASE */
1035 if (strEQ(remaining, "LOBAL_PHASE")) {
1036 sv_setpvn(sv, PL_phase_names[PL_phase],
1037 strlen(PL_phase_names[PL_phase]));
1038 }
1039 break;
a0d0e21e 1040 case '\010': /* ^H */
5d382c25 1041 sv_setuv(sv, PL_hints);
a0d0e21e 1042 break;
9d116dd7 1043 case '\011': /* ^I */ /* NOT \t in EBCDIC */
120f7abe 1044 sv_setpv(sv, PL_inplace); /* Will undefine sv if PL_inplace is NULL */
79072805 1045 break;
8561ea1d
FC
1046 case '\014': /* ^LAST_FH */
1047 if (strEQ(remaining, "AST_FH")) {
745e740c 1048 if (PL_last_in_gv && (SV*)PL_last_in_gv != &PL_sv_undef) {
8561ea1d
FC
1049 assert(isGV_with_GP(PL_last_in_gv));
1050 SV_CHECK_THINKFIRST_COW_DROP(sv);
1051 prepare_SV_for_RV(sv);
1052 SvOK_off(sv);
1053 SvRV_set(sv, SvREFCNT_inc_simple_NN(PL_last_in_gv));
1054 SvROK_on(sv);
1055 sv_rvweaken(sv);
1056 }
3773545d
DM
1057 else
1058 sv_set_undef(sv);
8561ea1d
FC
1059 }
1060 break;
ac27b0f5 1061 case '\017': /* ^O & ^OPEN */
823a54a3 1062 if (nextchar == '\0') {
ac27b0f5 1063 sv_setpv(sv, PL_osname);
3511154c
DM
1064 SvTAINTED_off(sv);
1065 }
823a54a3 1066 else if (strEQ(remaining, "PEN")) {
8b850bd5 1067 Perl_emulate_cop_io(aTHX_ &PL_compiling, sv);
ac27b0f5 1068 }
28f23441 1069 break;
9ebf26ad 1070 case '\020':
a6d0b1b5 1071 sv_setiv(sv, (IV)PL_perldb);
79072805 1072 break;
fb73857a 1073 case '\023': /* ^S */
f512d242 1074 if (nextchar == '\0') {
bc177e6b 1075 if (PL_parser && PL_parser->lex_state != LEX_NOTPARSING)
0c34ef67 1076 SvOK_off(sv);
3280af22 1077 else if (PL_in_eval)
6dc8a9e4 1078 sv_setiv(sv, PL_in_eval & ~(EVAL_INREQUIRE));
a4268c0a
AMS
1079 else
1080 sv_setiv(sv, 0);
d58bf5aa 1081 }
f512d242
KW
1082 else if (strEQ(remaining, "AFE_LOCALES")) {
1083
1084#if ! defined(USE_ITHREADS) || defined(USE_THREAD_SAFE_LOCALE)
1085
1086 sv_setuv(sv, (UV) 1);
1087
1088#else
1089 sv_setuv(sv, (UV) 0);
1090
1091#endif
1092
1093 }
fb73857a 1094 break;
79072805 1095 case '\024': /* ^T */
823a54a3 1096 if (nextchar == '\0') {
88e89b8a 1097#ifdef BIG_TIME
7c36658b 1098 sv_setnv(sv, PL_basetime);
88e89b8a 1099#else
7c36658b 1100 sv_setiv(sv, (IV)PL_basetime);
88e89b8a 1101#endif
7c36658b 1102 }
823a54a3 1103 else if (strEQ(remaining, "AINT"))
284167a5
SM
1104 sv_setiv(sv, TAINTING_get
1105 ? (TAINT_WARN_get || PL_unsafe ? -1 : 1)
9aa05f58 1106 : 0);
7c36658b 1107 break;
e07ea26a 1108 case '\025': /* $^UNICODE, $^UTF8LOCALE, $^UTF8CACHE */
823a54a3 1109 if (strEQ(remaining, "NICODE"))
a05d7ebb 1110 sv_setuv(sv, (UV) PL_unicode);
823a54a3 1111 else if (strEQ(remaining, "TF8LOCALE"))
7cebcbc0 1112 sv_setuv(sv, (UV) PL_utf8locale);
e07ea26a
NC
1113 else if (strEQ(remaining, "TF8CACHE"))
1114 sv_setiv(sv, (IV) PL_utf8cache);
fde18df1
JH
1115 break;
1116 case '\027': /* ^W & $^WARNING_BITS */
823a54a3 1117 if (nextchar == '\0')
8298454c 1118 sv_setiv(sv, (IV)cBOOL(PL_dowarn & G_WARN_ON));
823a54a3 1119 else if (strEQ(remaining, "ARNING_BITS")) {
013b78e8 1120 if (PL_compiling.cop_warnings == pWARN_NONE) {
4438c4b7 1121 sv_setpvn(sv, WARN_NONEstring, WARNsize) ;
013b78e8
RGS
1122 }
1123 else if (PL_compiling.cop_warnings == pWARN_STD) {
e03e82a0 1124 goto set_undef;
013b78e8 1125 }
d3a7d8c7 1126 else if (PL_compiling.cop_warnings == pWARN_ALL) {
006c1a1d 1127 sv_setpvn(sv, WARN_ALLstring, WARNsize);
ac27b0f5 1128 }
4438c4b7 1129 else {
72dc9ed5
NC
1130 sv_setpvn(sv, (char *) (PL_compiling.cop_warnings + 1),
1131 *PL_compiling.cop_warnings);
ac27b0f5 1132 }
4438c4b7 1133 }
8ca2a5d6
DD
1134#ifdef WIN32
1135 else if (strEQ(remaining, "IN32_SLOPPY_STAT")) {
1136 sv_setiv(sv, w32_sloppystat);
1137 }
1138#endif
79072805 1139 break;
79072805 1140 case '+':
aaa362c4 1141 if (PL_curpm && (rx = PM_GETRE(PL_curpm))) {
2c7b5d76
DM
1142 paren = RX_LASTPAREN(rx);
1143 if (paren)
1144 goto do_numbuf_fetch;
79072805 1145 }
e03e82a0 1146 goto set_undef;
a01268b5
JH
1147 case '\016': /* ^N */
1148 if (PL_curpm && (rx = PM_GETRE(PL_curpm))) {
2c7b5d76
DM
1149 paren = RX_LASTCLOSEPAREN(rx);
1150 if (paren)
1151 goto do_numbuf_fetch;
a01268b5 1152 }
e03e82a0 1153 goto set_undef;
79072805 1154 case '.':
3280af22 1155 if (GvIO(PL_last_in_gv)) {
357c8808 1156 sv_setiv(sv, (IV)IoLINES(GvIOp(PL_last_in_gv)));
79072805 1157 }
79072805
LW
1158 break;
1159 case '?':
809a5acc 1160 {
809a5acc 1161 sv_setiv(sv, (IV)STATUS_CURRENT);
ff0cee69 1162#ifdef COMPLEX_STATUS
41cb7b2b 1163 SvUPGRADE(sv, SVt_PVLV);
6b88bc9c
GS
1164 LvTARGOFF(sv) = PL_statusvalue;
1165 LvTARGLEN(sv) = PL_statusvalue_vms;
ff0cee69 1166#endif
809a5acc 1167 }
79072805
LW
1168 break;
1169 case '^':
acbe1b9d 1170 if (GvIOp(PL_defoutgv))
099be4f1 1171 s = IoTOP_NAME(GvIOp(PL_defoutgv));
79072805
LW
1172 if (s)
1173 sv_setpv(sv,s);
1174 else {
3280af22 1175 sv_setpv(sv,GvENAME(PL_defoutgv));
cb421d5e 1176 sv_catpvs(sv,"_TOP");
79072805
LW
1177 }
1178 break;
1179 case '~':
acbe1b9d 1180 if (GvIOp(PL_defoutgv))
0daa599b 1181 s = IoFMT_NAME(GvIOp(PL_defoutgv));
79072805 1182 if (!s)
3280af22 1183 s = GvENAME(PL_defoutgv);
79072805
LW
1184 sv_setpv(sv,s);
1185 break;
79072805 1186 case '=':
099be4f1 1187 if (GvIO(PL_defoutgv))
0daa599b 1188 sv_setiv(sv, (IV)IoPAGE_LEN(GvIOp(PL_defoutgv)));
79072805
LW
1189 break;
1190 case '-':
099be4f1 1191 if (GvIO(PL_defoutgv))
0daa599b 1192 sv_setiv(sv, (IV)IoLINES_LEFT(GvIOp(PL_defoutgv)));
79072805
LW
1193 break;
1194 case '%':
099be4f1 1195 if (GvIO(PL_defoutgv))
0daa599b 1196 sv_setiv(sv, (IV)IoPAGE(GvIOp(PL_defoutgv)));
79072805 1197 break;
79072805 1198 case ':':
79072805
LW
1199 case '/':
1200 break;
1201 case '[':
e1dccc0d 1202 sv_setiv(sv, 0);
79072805
LW
1203 break;
1204 case '|':
099be4f1 1205 if (GvIO(PL_defoutgv))
0daa599b 1206 sv_setiv(sv, (IV)(IoFLAGS(GvIOp(PL_defoutgv)) & IOf_FLUSH) != 0 );
79072805 1207 break;
79072805 1208 case '\\':
b2ce0fda 1209 if (PL_ors_sv)
f28098ff 1210 sv_copypv(sv, PL_ors_sv);
4bac9ae4 1211 else
e03e82a0 1212 goto set_undef;
79072805 1213 break;
0e219455 1214 case '$': /* $$ */
9cdac2a2
FC
1215 {
1216 IV const pid = (IV)PerlProc_getpid();
19db9fb7 1217 if (isGV(mg->mg_obj) || SvIV(mg->mg_obj) != pid) {
9cdac2a2
FC
1218 /* never set manually, or at least not since last fork */
1219 sv_setiv(sv, pid);
19db9fb7
Z
1220 /* never unsafe, even if reading in a tainted expression */
1221 SvTAINTED_off(sv);
1222 }
9cdac2a2
FC
1223 /* else a value has been assigned manually, so do nothing */
1224 }
0e219455 1225 break;
79072805 1226 case '<':
dfff4baf 1227 sv_setuid(sv, PerlProc_getuid());
79072805
LW
1228 break;
1229 case '>':
dfff4baf 1230 sv_setuid(sv, PerlProc_geteuid());
79072805
LW
1231 break;
1232 case '(':
dfff4baf 1233 sv_setgid(sv, PerlProc_getgid());
79072805
LW
1234 goto add_groups;
1235 case ')':
dfff4baf 1236 sv_setgid(sv, PerlProc_getegid());
79072805 1237 add_groups:
79072805 1238#ifdef HAS_GETGROUPS
79072805 1239 {
57d7c65e 1240 Groups_t *gary = NULL;
375ed12a
JH
1241 I32 num_groups = getgroups(0, gary);
1242 if (num_groups > 0) {
19742f39 1243 I32 i;
375ed12a
JH
1244 Newx(gary, num_groups, Groups_t);
1245 num_groups = getgroups(num_groups, gary);
1246 for (i = 0; i < num_groups; i++)
147e3846 1247 Perl_sv_catpvf(aTHX_ sv, " %" IVdf, (IV)gary[i]);
375ed12a
JH
1248 Safefree(gary);
1249 }
79072805 1250 }
155aba94 1251 (void)SvIOK_on(sv); /* what a wonderful hack! */
cd70abae 1252#endif
79072805 1253 break;
79072805
LW
1254 case '0':
1255 break;
1256 }
a0d0e21e 1257 return 0;
e03e82a0
DM
1258
1259 set_undef:
1260 sv_set_undef(sv);
1261 return 0;
79072805
LW
1262}
1263
1264int
864dbfa3 1265Perl_magic_getuvar(pTHX_ SV *sv, MAGIC *mg)
79072805 1266{
8772537c 1267 struct ufuncs * const uf = (struct ufuncs *)mg->mg_ptr;
79072805 1268
7918f24d
NC
1269 PERL_ARGS_ASSERT_MAGIC_GETUVAR;
1270
79072805 1271 if (uf && uf->uf_val)
24f81a43 1272 (*uf->uf_val)(aTHX_ uf->uf_index, sv);
79072805
LW
1273 return 0;
1274}
1275
1276int
864dbfa3 1277Perl_magic_setenv(pTHX_ SV *sv, MAGIC *mg)
79072805 1278{
9ae3433d 1279 STRLEN len = 0, klen;
12033064 1280 const char * const key = MgPV_const(mg,klen);
888a67f6 1281 const char *s = "";
1e422769 1282
7918f24d
NC
1283 PERL_ARGS_ASSERT_MAGIC_SETENV;
1284
613c63b4 1285 SvGETMAGIC(sv);
12033064 1286 if (SvOK(sv)) {
613c63b4
CS
1287 /* defined environment variables are byte strings; unfortunately
1288 there is no SvPVbyte_force_nomg(), so we must do this piecewise */
1289 (void)SvPV_force_nomg_nolen(sv);
1290 sv_utf8_downgrade(sv, /* fail_ok */ TRUE);
1291 if (SvUTF8(sv)) {
1292 Perl_ck_warner_d(aTHX_ packWARN(WARN_UTF8), "Wide character in %s", "setenv");
1293 SvUTF8_off(sv);
1294 }
1295 s = SvPVX(sv);
1296 len = SvCUR(sv);
12033064
CS
1297 }
1298 my_setenv(key, s); /* does the deed */
1299
a0d0e21e
LW
1300#ifdef DYNAMIC_ENV_FETCH
1301 /* We just undefd an environment var. Is a replacement */
1302 /* waiting in the wings? */
1303 if (!len) {
6bd66ee9 1304 SV ** const valp = hv_fetch(GvHVn(PL_envgv), key, klen, FALSE);
fabdb6c0 1305 if (valp)
4ab59fcc 1306 s = SvOK(*valp) ? SvPV_const(*valp, len) : "";
a0d0e21e
LW
1307 }
1308#endif
1e422769 1309
28542d8f 1310#if !defined(OS2) && !defined(WIN32) && !defined(MSDOS)
79072805
LW
1311 /* And you'll never guess what the dog had */
1312 /* in its mouth... */
284167a5 1313 if (TAINTING_get) {
1e422769
PP
1314 MgTAINTEDDIR_off(mg);
1315#ifdef VMS
b2aed775 1316 if (s && memEQs(key, klen, "DCL$PATH")) {
b8ffc8df 1317 char pathbuf[256], eltbuf[256], *cp, *elt;
1e422769
PP
1318 int i = 0, j = 0;
1319
6fca0082 1320 my_strlcpy(eltbuf, s, sizeof(eltbuf));
b8ffc8df 1321 elt = eltbuf;
1e422769
PP
1322 do { /* DCL$PATH may be a search list */
1323 while (1) { /* as may dev portion of any element */
1324 if ( ((cp = strchr(elt,'[')) || (cp = strchr(elt,'<'))) ) {
1325 if ( *(cp+1) == '.' || *(cp+1) == '-' ||
1326 cando_by_name(S_IWUSR,0,elt) ) {
1327 MgTAINTEDDIR_on(mg);
1328 return 0;
1329 }
1330 }
bd61b366 1331 if ((cp = strchr(elt, ':')) != NULL)
1e422769
PP
1332 *cp = '\0';
1333 if (my_trnlnm(elt, eltbuf, j++))
1334 elt = eltbuf;
1335 else
1336 break;
1337 }
1338 j = 0;
1339 } while (my_trnlnm(s, pathbuf, i++) && (elt = pathbuf));
1340 }
1341#endif /* VMS */
b2aed775 1342 if (s && memEQs(key, klen, "PATH")) {
8772537c 1343 const char * const strend = s + len;
463ee0b2 1344
70b484a8
DM
1345 /* set MGf_TAINTEDDIR if any component of the new path is
1346 * relative or world-writeable */
463ee0b2 1347 while (s < strend) {
96827780 1348 char tmpbuf[256];
c623ac67 1349 Stat_t st;
5f74f29c 1350 I32 i;
83269ced
CB
1351#ifdef __VMS /* Hmm. How do we get $Config{path_sep} from C? */
1352 const char path_sep = PL_perllib_sep;
f5a63d97
AL
1353#else
1354 const char path_sep = ':';
1355#endif
ba0a4150 1356 s = delimcpy_no_escape(tmpbuf, tmpbuf + sizeof tmpbuf,
427eaa01 1357 s, strend, path_sep, &i);
463ee0b2 1358 s++;
bb7a0f54 1359 if (i >= (I32)sizeof tmpbuf /* too long -- assume the worst */
83269ced
CB
1360#ifdef __VMS
1361 /* no colon thus no device name -- assume relative path */
1362 || (PL_perllib_sep != ':' && !strchr(tmpbuf, ':'))
1363 /* Using Unix separator, e.g. under bash, so act line Unix */
1364 || (PL_perllib_sep == ':' && *tmpbuf != '/')
326b5008
CB
1365#else
1366 || *tmpbuf != '/' /* no starting slash -- assume relative path */
1367#endif
c6ed36e1 1368 || (PerlLIO_stat(tmpbuf, &st) == 0 && (st.st_mode & 2)) ) {
8990e307 1369 MgTAINTEDDIR_on(mg);
1e422769
PP
1370 return 0;
1371 }
463ee0b2 1372 }
79072805
LW
1373 }
1374 }
28542d8f 1375#endif /* neither OS2 nor WIN32 nor MSDOS */
1e422769 1376
79072805
LW
1377 return 0;
1378}
1379
1380int
864dbfa3 1381Perl_magic_clearenv(pTHX_ SV *sv, MAGIC *mg)
85e6fe83 1382{
7918f24d 1383 PERL_ARGS_ASSERT_MAGIC_CLEARENV;
8772537c 1384 PERL_UNUSED_ARG(sv);
bd61b366 1385 my_setenv(MgPV_nolen_const(mg),NULL);
85e6fe83
LW
1386 return 0;
1387}
1388
88e89b8a 1389int
864dbfa3 1390Perl_magic_set_all_env(pTHX_ SV *sv, MAGIC *mg)
fb73857a 1391{
7918f24d 1392 PERL_ARGS_ASSERT_MAGIC_SET_ALL_ENV;
65e66c80 1393 PERL_UNUSED_ARG(mg);
b0269e46 1394#if defined(VMS)
cea2e8a9 1395 Perl_die(aTHX_ "Can't make list assignment to %%ENV on this system");
fb73857a 1396#else
3280af22 1397 if (PL_localizing) {
fb73857a 1398 HE* entry;
b0269e46 1399 my_clearenv();
85fbaab2
NC
1400 hv_iterinit(MUTABLE_HV(sv));
1401 while ((entry = hv_iternext(MUTABLE_HV(sv)))) {
fb73857a
PP
1402 I32 keylen;
1403 my_setenv(hv_iterkey(entry, &keylen),
85fbaab2 1404 SvPV_nolen_const(hv_iterval(MUTABLE_HV(sv), entry)));
fb73857a
PP
1405 }
1406 }
1407#endif
1408 return 0;
1409}
1410
1411int
864dbfa3 1412Perl_magic_clear_all_env(pTHX_ SV *sv, MAGIC *mg)
66b1d557 1413{
7918f24d 1414 PERL_ARGS_ASSERT_MAGIC_CLEAR_ALL_ENV;
8772537c
AL
1415 PERL_UNUSED_ARG(sv);
1416 PERL_UNUSED_ARG(mg);
b0269e46
AB
1417#if defined(VMS)
1418 Perl_die(aTHX_ "Can't make list assignment to %%ENV on this system");
1419#else
1420 my_clearenv();
1421#endif
3e3baf6d 1422 return 0;
66b1d557
HM
1423}
1424
64ca3a65 1425#ifndef PERL_MICRO
2d4fcd5e
AJ
1426#ifdef HAS_SIGPROCMASK
1427static void
1428restore_sigmask(pTHX_ SV *save_sv)
1429{
0bd48802 1430 const sigset_t * const ossetp = (const sigset_t *) SvPV_nolen_const( save_sv );
f5a63d97 1431 (void)sigprocmask(SIG_SETMASK, ossetp, NULL);
2d4fcd5e
AJ
1432}
1433#endif
66b1d557 1434int
864dbfa3 1435Perl_magic_getsig(pTHX_ SV *sv, MAGIC *mg)
88e89b8a 1436{
88e89b8a 1437 /* Are we fetching a signal entry? */
708854f2 1438 int i = (I16)mg->mg_private;
7918f24d
NC
1439
1440 PERL_ARGS_ASSERT_MAGIC_GETSIG;
1441
708854f2 1442 if (!i) {
84c7b88c
BF
1443 STRLEN siglen;
1444 const char * sig = MgPV_const(mg, siglen);
1445 mg->mg_private = i = whichsig_pvn(sig, siglen);
708854f2
NC
1446 }
1447
e02bfb16 1448 if (i > 0) {
22c35a8c
GS
1449 if(PL_psig_ptr[i])
1450 sv_setsv(sv,PL_psig_ptr[i]);
88e89b8a 1451 else {
46da273f 1452 Sighandler_t sigstate = rsignal_state(i);
23ada85b 1453#ifdef FAKE_PERSISTENT_SIGNAL_HANDLERS
46da273f
AL
1454 if (PL_sig_handlers_initted && PL_sig_ignoring[i])
1455 sigstate = SIG_IGN;
2e34cc90
CL
1456#endif
1457#ifdef FAKE_DEFAULT_SIGNAL_HANDLERS
46da273f
AL
1458 if (PL_sig_handlers_initted && PL_sig_defaulting[i])
1459 sigstate = SIG_DFL;
85b332e2 1460#endif
88e89b8a 1461 /* cache state so we don't fetch it again */
8aad04aa 1462 if(sigstate == (Sighandler_t) SIG_IGN)
6502358f 1463 sv_setpvs(sv,"IGNORE");
88e89b8a 1464 else
e03e82a0 1465 sv_set_undef(sv);
46da273f 1466 PL_psig_ptr[i] = SvREFCNT_inc_simple_NN(sv);
88e89b8a
PP
1467 SvTEMP_off(sv);
1468 }
1469 }
1470 return 0;
1471}
1472int
864dbfa3 1473Perl_magic_clearsig(pTHX_ SV *sv, MAGIC *mg)
88e89b8a 1474{
7918f24d 1475 PERL_ARGS_ASSERT_MAGIC_CLEARSIG;
179c85a2 1476
38a124f0 1477 magic_setsig(NULL, mg);
179c85a2 1478 return sv_unmagic(sv, mg->mg_type);
88e89b8a 1479}
3d37d572 1480
dc37125b 1481
5e7940ce 1482#ifdef PERL_USE_3ARG_SIGHANDLER
dc37125b
DM
1483Signal_t
1484Perl_csighandler(int sig, Siginfo_t *sip, void *uap)
1485{
1486 Perl_csighandler3(sig, sip, uap);
1487}
8aad04aa 1488#else
dc37125b 1489Signal_t
0a8e0eff 1490Perl_csighandler(int sig)
dc37125b
DM
1491{
1492 Perl_csighandler3(sig, NULL, NULL);
1493}
8aad04aa 1494#endif
dc37125b
DM
1495
1496Signal_t
1497Perl_csighandler1(int sig)
1498{
1499 Perl_csighandler3(sig, NULL, NULL);
1500}
1501
1502/* Handler intended to directly handle signal calls from the kernel.
1503 * (Depending on configuration, the kernel may actually call one of the
1504 * wrappers csighandler() or csighandler1() instead.)
1505 * It either queues up the signal or dispatches it immediately depending
1506 * on whether safe signals are enabled and whether the signal is capable
1507 * of being deferred (e.g. SEGV isn't).
1508 */
1509
1510Signal_t
1511Perl_csighandler3(int sig, Siginfo_t *sip PERL_UNUSED_DECL, void *uap PERL_UNUSED_DECL)
0a8e0eff 1512{
1018e26f
NIS
1513#ifdef PERL_GET_SIG_CONTEXT
1514 dTHXa(PERL_GET_SIG_CONTEXT);
1515#else
85b332e2
CL
1516 dTHX;
1517#endif
5e7940ce
DM
1518
1519#ifdef PERL_USE_3ARG_SIGHANDLER
ffb6256b
JH
1520#if defined(__cplusplus) && defined(__GNUC__)
1521 /* g++ doesn't support PERL_UNUSED_DECL, so the sip and uap
1522 * parameters would be warned about. */
1523 PERL_UNUSED_ARG(sip);
1524 PERL_UNUSED_ARG(uap);
1525#endif
1271a1be 1526#endif
5e7940ce 1527
23ada85b 1528#ifdef FAKE_PERSISTENT_SIGNAL_HANDLERS
5c1546dc 1529 (void) rsignal(sig, PL_csighandlerp);
27da23d5 1530 if (PL_sig_ignoring[sig]) return;
85b332e2 1531#endif
2e34cc90 1532#ifdef FAKE_DEFAULT_SIGNAL_HANDLERS
27da23d5 1533 if (PL_sig_defaulting[sig])
2e34cc90
CL
1534#ifdef KILL_BY_SIGPRC
1535 exit((Perl_sig_to_vmscondition(sig)&STS$M_COND_ID)|STS$K_SEVERE|STS$M_INHIB_MSG);
1536#else
1537 exit(1);
1538#endif
1539#endif
406878dd 1540 if (
853d2c32
RGS
1541#ifdef SIGILL
1542 sig == SIGILL ||
1543#endif
1544#ifdef SIGBUS
1545 sig == SIGBUS ||
1546#endif
1547#ifdef SIGSEGV
1548 sig == SIGSEGV ||
1549#endif
1550 (PL_signals & PERL_SIGNALS_UNSAFE_FLAG))
4ffa73a3 1551 /* Call the perl level handler now--
31c91b43 1552 * with risk we may be in malloc() or being destructed etc. */
8a5e470b
DM
1553 {
1554 if (PL_sighandlerp == Perl_sighandler)
1555 /* default handler, so can call perly_sighandler() directly
1556 * rather than via Perl_sighandler, passing the extra
1557 * 'safe = false' arg
1558 */
ddb513d5 1559 Perl_perly_sighandler(sig, NULL, NULL, 0 /* unsafe */);
8a5e470b 1560 else
5e7940ce 1561#ifdef PERL_USE_3ARG_SIGHANDLER
8a5e470b 1562 (*PL_sighandlerp)(sig, NULL, NULL);
6e324d09 1563#else
8a5e470b 1564 (*PL_sighandlerp)(sig);
92807b6d 1565#endif
8a5e470b 1566 }
406878dd 1567 else {
31c91b43 1568 if (!PL_psig_pend) return;
406878dd
GA
1569 /* Set a flag to say this signal is pending, that is awaiting delivery after
1570 * the current Perl opcode completes */
1571 PL_psig_pend[sig]++;
1572
1573#ifndef SIG_PENDING_DIE_COUNT
1574# define SIG_PENDING_DIE_COUNT 120
1575#endif
fe13d51d 1576 /* Add one to say _a_ signal is pending */
406878dd
GA
1577 if (++PL_sig_pending >= SIG_PENDING_DIE_COUNT)
1578 Perl_croak(aTHX_ "Maximal count of pending signals (%lu) exceeded",
1579 (unsigned long)SIG_PENDING_DIE_COUNT);
1580 }
0a8e0eff
NIS
1581}
1582
2e34cc90
CL
1583#if defined(FAKE_PERSISTENT_SIGNAL_HANDLERS) || defined(FAKE_DEFAULT_SIGNAL_HANDLERS)
1584void
1585Perl_csighandler_init(void)
1586{
1587 int sig;
27da23d5 1588 if (PL_sig_handlers_initted) return;
2e34cc90
CL
1589
1590 for (sig = 1; sig < SIG_SIZE; sig++) {
1591#ifdef FAKE_DEFAULT_SIGNAL_HANDLERS
218fdd94 1592 dTHX;
27da23d5 1593 PL_sig_defaulting[sig] = 1;
5c1546dc 1594 (void) rsignal(sig, PL_csighandlerp);
2e34cc90
CL
1595#endif
1596#ifdef FAKE_PERSISTENT_SIGNAL_HANDLERS
27da23d5 1597 PL_sig_ignoring[sig] = 0;
2e34cc90
CL
1598#endif
1599 }
27da23d5 1600 PL_sig_handlers_initted = 1;
2e34cc90
CL
1601}
1602#endif
1603
7fe50b8b
LT
1604#if defined HAS_SIGPROCMASK
1605static void
1606unblock_sigmask(pTHX_ void* newset)
1607{
dc3bf405 1608 PERL_UNUSED_CONTEXT;
7fe50b8b
LT
1609 sigprocmask(SIG_UNBLOCK, (sigset_t*)newset, NULL);
1610}
1611#endif
1612
0a8e0eff
NIS
1613void
1614Perl_despatch_signals(pTHX)
1615{
1616 int sig;
1617 PL_sig_pending = 0;
1618 for (sig = 1; sig < SIG_SIZE; sig++) {
1619 if (PL_psig_pend[sig]) {
d0166017 1620 dSAVE_ERRNO;
7fe50b8b 1621#ifdef HAS_SIGPROCMASK
55534442
LT
1622 /* From sigaction(2) (FreeBSD man page):
1623 * | Signal routines normally execute with the signal that
1624 * | caused their invocation blocked, but other signals may
1625 * | yet occur.
1626 * Emulation of this behavior (from within Perl) is enabled
1627 * using sigprocmask
1628 */
1629 int was_blocked;
1630 sigset_t newset, oldset;
1631
1632 sigemptyset(&newset);
1633 sigaddset(&newset, sig);
1634 sigprocmask(SIG_BLOCK, &newset, &oldset);
1635 was_blocked = sigismember(&oldset, sig);
7fe50b8b
LT
1636 if (!was_blocked) {
1637 SV* save_sv = newSVpvn((char *)(&newset), sizeof(sigset_t));
1638 ENTER;
1639 SAVEFREESV(save_sv);
1640 SAVEDESTRUCTOR_X(unblock_sigmask, SvPV_nolen(save_sv));
1641 }
55534442 1642#endif
25da4428 1643 PL_psig_pend[sig] = 0;
8a5e470b
DM
1644 if (PL_sighandlerp == Perl_sighandler)
1645 /* default handler, so can call perly_sighandler() directly
1646 * rather than via Perl_sighandler, passing the extra
1647 * 'safe = true' arg
1648 */
1649 Perl_perly_sighandler(sig, NULL, NULL, 1 /* safe */);
1650 else
5e7940ce 1651#ifdef PERL_USE_3ARG_SIGHANDLER
8a5e470b 1652 (*PL_sighandlerp)(sig, NULL, NULL);
6e324d09 1653#else
8a5e470b 1654 (*PL_sighandlerp)(sig);
92807b6d 1655#endif
8a5e470b 1656
7fe50b8b 1657#ifdef HAS_SIGPROCMASK
55534442 1658 if (!was_blocked)
7fe50b8b 1659 LEAVE;
55534442 1660#endif
d0166017 1661 RESTORE_ERRNO;
0a8e0eff
NIS
1662 }
1663 }
1664}
1665
38a124f0 1666/* sv of NULL signifies that we're acting as magic_clearsig. */
85e6fe83 1667int
864dbfa3 1668Perl_magic_setsig(pTHX_ SV *sv, MAGIC *mg)
79072805 1669{
79072805 1670 I32 i;
cbbf8932 1671 SV** svp = NULL;
2d4fcd5e
AJ
1672 /* Need to be careful with SvREFCNT_dec(), because that can have side
1673 * effects (due to closures). We must make sure that the new disposition
1674 * is in place before it is called.
1675 */
cbbf8932 1676 SV* to_dec = NULL;
e72dc28c 1677 STRLEN len;
2d4fcd5e
AJ
1678#ifdef HAS_SIGPROCMASK
1679 sigset_t set, save;
1680 SV* save_sv;
1681#endif
eb578fdb 1682 const char *s = MgPV_const(mg,len);
7918f24d
NC
1683
1684 PERL_ARGS_ASSERT_MAGIC_SETSIG;
1685
748a9306 1686 if (*s == '_') {
84c7b88c 1687 if (memEQs(s, len, "__DIE__"))
3280af22 1688 svp = &PL_diehook;
84c7b88c 1689 else if (memEQs(s, len, "__WARN__")
38a124f0
NC
1690 && (sv ? 1 : PL_warnhook != PERL_WARNHOOK_FATAL)) {
1691 /* Merge the existing behaviours, which are as follows:
1692 magic_setsig, we always set svp to &PL_warnhook
1693 (hence we always change the warnings handler)
1694 For magic_clearsig, we don't change the warnings handler if it's
1695 set to the &PL_warnhook. */
3280af22 1696 svp = &PL_warnhook;
84c7b88c
BF
1697 } else if (sv) {
1698 SV *tmp = sv_newmortal();
1699 Perl_croak(aTHX_ "No such hook: %s",
1700 pv_pretty(tmp, s, len, 0, NULL, NULL, 0));
1701 }
748a9306 1702 i = 0;
38a124f0 1703 if (svp && *svp) {
9289f461
RGS
1704 if (*svp != PERL_WARNHOOK_FATAL)
1705 to_dec = *svp;
cbbf8932 1706 *svp = NULL;
4633a7c4 1707 }
748a9306
LW
1708 }
1709 else {
708854f2
NC
1710 i = (I16)mg->mg_private;
1711 if (!i) {
84c7b88c 1712 i = whichsig_pvn(s, len); /* ...no, a brick */
58a26b12 1713 mg->mg_private = (U16)i;
708854f2 1714 }
86d86cad 1715 if (i <= 0) {
84c7b88c
BF
1716 if (sv) {
1717 SV *tmp = sv_newmortal();
1718 Perl_ck_warner(aTHX_ packWARN(WARN_SIGNAL), "No such signal: SIG%s",
1719 pv_pretty(tmp, s, len, 0, NULL, NULL, 0));
1720 }
748a9306
LW
1721 return 0;
1722 }
2d4fcd5e
AJ
1723#ifdef HAS_SIGPROCMASK
1724 /* Avoid having the signal arrive at a bad time, if possible. */
1725 sigemptyset(&set);
1726 sigaddset(&set,i);
1727 sigprocmask(SIG_BLOCK, &set, &save);
1728 ENTER;
9ff8e806 1729 save_sv = newSVpvn((char *)(&save), sizeof(sigset_t));
2d4fcd5e
AJ
1730 SAVEFREESV(save_sv);
1731 SAVEDESTRUCTOR_X(restore_sigmask, save_sv);
1732#endif
1733 PERL_ASYNC_CHECK();
2e34cc90 1734#if defined(FAKE_PERSISTENT_SIGNAL_HANDLERS) || defined(FAKE_DEFAULT_SIGNAL_HANDLERS)
27da23d5 1735 if (!PL_sig_handlers_initted) Perl_csighandler_init();
2e34cc90 1736#endif
23ada85b 1737#ifdef FAKE_PERSISTENT_SIGNAL_HANDLERS
27da23d5 1738 PL_sig_ignoring[i] = 0;
85b332e2 1739#endif
2e34cc90 1740#ifdef FAKE_DEFAULT_SIGNAL_HANDLERS
27da23d5 1741 PL_sig_defaulting[i] = 0;
2e34cc90 1742#endif
2d4fcd5e 1743 to_dec = PL_psig_ptr[i];
38a124f0
NC
1744 if (sv) {
1745 PL_psig_ptr[i] = SvREFCNT_inc_simple_NN(sv);
1746 SvTEMP_off(sv); /* Make sure it doesn't go away on us */
79fd3822
NC
1747
1748 /* Signals don't change name during the program's execution, so once
1749 they're cached in the appropriate slot of PL_psig_name, they can
1750 stay there.
1751
1752 Ideally we'd find some way of making SVs at (C) compile time, or
1753 at least, doing most of the work. */
1754 if (!PL_psig_name[i]) {
92d4124b
TR
1755 const char* name = PL_sig_name[i];
1756 PL_psig_name[i] = newSVpvn(name, strlen(name));
79fd3822
NC
1757 SvREADONLY_on(PL_psig_name[i]);
1758 }
38a124f0 1759 } else {
79fd3822 1760 SvREFCNT_dec(PL_psig_name[i]);
38a124f0
NC
1761 PL_psig_name[i] = NULL;
1762 PL_psig_ptr[i] = NULL;
1763 }
748a9306 1764 }
38a124f0 1765 if (sv && (isGV_with_GP(sv) || SvROK(sv))) {
2d4fcd5e 1766 if (i) {
5c1546dc 1767 (void)rsignal(i, PL_csighandlerp);
2d4fcd5e 1768 }
748a9306 1769 else
b37c2d43 1770 *svp = SvREFCNT_inc_simple_NN(sv);
38a124f0 1771 } else {
9dfa190b
NC
1772 if (sv && SvOK(sv)) {
1773 s = SvPV_force(sv, len);
1774 } else {
1775 sv = NULL;
1776 }
84c7b88c 1777 if (sv && memEQs(s, len,"IGNORE")) {
9dfa190b 1778 if (i) {
23ada85b 1779#ifdef FAKE_PERSISTENT_SIGNAL_HANDLERS
9dfa190b
NC
1780 PL_sig_ignoring[i] = 1;
1781 (void)rsignal(i, PL_csighandlerp);
85b332e2 1782#else
9dfa190b 1783 (void)rsignal(i, (Sighandler_t) SIG_IGN);
85b332e2 1784#endif
9dfa190b 1785 }
2d4fcd5e 1786 }
84c7b88c 1787 else if (!sv || memEQs(s, len,"DEFAULT") || !len) {
9dfa190b 1788 if (i) {
2e34cc90 1789#ifdef FAKE_DEFAULT_SIGNAL_HANDLERS
9dfa190b
NC
1790 PL_sig_defaulting[i] = 1;
1791 (void)rsignal(i, PL_csighandlerp);
2e34cc90 1792#else
9dfa190b 1793 (void)rsignal(i, (Sighandler_t) SIG_DFL);
2e34cc90 1794#endif
9dfa190b
NC
1795 }
1796 }
1797 else {
1798 /*
1799 * We should warn if HINT_STRICT_REFS, but without
1800 * access to a known hint bit in a known OP, we can't
1801 * tell whether HINT_STRICT_REFS is in force or not.
1802 */
0687887e 1803 if (!memchr(s, ':', len) && !memchr(s, '\'', len))
9dfa190b
NC
1804 Perl_sv_insert_flags(aTHX_ sv, 0, 0, STR_WITH_LEN("main::"),
1805 SV_GMAGIC);
1806 if (i)
1807 (void)rsignal(i, PL_csighandlerp);
1808 else
1809 *svp = SvREFCNT_inc_simple_NN(sv);
136e0459 1810 }
748a9306 1811 }
9dfa190b 1812
2d4fcd5e
AJ
1813#ifdef HAS_SIGPROCMASK
1814 if(i)
1815 LEAVE;
1816#endif
ef8d46e8 1817 SvREFCNT_dec(to_dec);
79072805
LW
1818 return 0;
1819}
64ca3a65 1820#endif /* !PERL_MICRO */
79072805
LW
1821
1822int
864dbfa3 1823Perl_magic_setisa(pTHX_ SV *sv, MAGIC *mg)
79072805 1824{
7918f24d 1825 PERL_ARGS_ASSERT_MAGIC_SETISA;
8772537c 1826 PERL_UNUSED_ARG(sv);
e1a479c5 1827
89c14e2e 1828 /* Skip _isaelem because _isa will handle it shortly */
354b0578 1829 if (PL_delaymagic & DM_ARRAY_ISA && mg->mg_type == PERL_MAGIC_isaelem)
89c14e2e
BB
1830 return 0;
1831
0e446081 1832 return magic_clearisa(NULL, mg);
463ee0b2
LW
1833}
1834
0e446081 1835/* sv of NULL signifies that we're acting as magic_setisa. */
463ee0b2 1836int
52b45067
RD
1837Perl_magic_clearisa(pTHX_ SV *sv, MAGIC *mg)
1838{
52b45067 1839 HV* stash;
7918f24d
NC
1840 PERL_ARGS_ASSERT_MAGIC_CLEARISA;
1841
52b45067 1842 /* Bail out if destruction is going on */
627364f1 1843 if(PL_phase == PERL_PHASE_DESTRUCT) return 0;
52b45067 1844
0e446081
NC
1845 if (sv)
1846 av_clear(MUTABLE_AV(sv));
52b45067 1847
6624142a
FC
1848 if (SvTYPE(mg->mg_obj) != SVt_PVGV && SvSMAGICAL(mg->mg_obj))
1849 /* This occurs with setisa_elem magic, which calls this
1850 same function. */
1851 mg = mg_find(mg->mg_obj, PERL_MAGIC_isa);
1852
316ebaf2 1853 assert(mg);
6624142a
FC
1854 if (SvTYPE(mg->mg_obj) == SVt_PVAV) { /* multiple stashes */
1855 SV **svp = AvARRAY((AV *)mg->mg_obj);
1856 I32 items = AvFILLp((AV *)mg->mg_obj) + 1;
1857 while (items--) {
1858 stash = GvSTASH((GV *)*svp++);
1859 if (stash && HvENAME(stash)) mro_isa_changed_in(stash);
1860 }
1861
1862 return 0;
1863 }
1864
52b45067 1865 stash = GvSTASH(
6624142a 1866 (const GV *)mg->mg_obj
52b45067
RD
1867 );
1868
00169e2c
FC
1869 /* The stash may have been detached from the symbol table, so check its
1870 name before doing anything. */
1871 if (stash && HvENAME_get(stash))
5562fa71 1872 mro_isa_changed_in(stash);
52b45067
RD
1873
1874 return 0;
1875}
1876
1877int
864dbfa3 1878Perl_magic_getnkeys(pTHX_ SV *sv, MAGIC *mg)
6ff81951 1879{
85fbaab2 1880 HV * const hv = MUTABLE_HV(LvTARG(sv));
6ff81951 1881 I32 i = 0;
7918f24d
NC
1882
1883 PERL_ARGS_ASSERT_MAGIC_GETNKEYS;
8772537c 1884 PERL_UNUSED_ARG(mg);
7719e241 1885
6ff81951 1886 if (hv) {
497b47a8 1887 (void) hv_iterinit(hv);
ad64d0ec 1888 if (! SvTIED_mg((const SV *)hv, PERL_MAGIC_tied))
1b95d04f 1889 i = HvUSEDKEYS(hv);
497b47a8
JH
1890 else {
1891 while (hv_iternext(hv))
1892 i++;
1893 }
6ff81951
GS
1894 }
1895
1896 sv_setiv(sv, (IV)i);
1897 return 0;
1898}
1899
1900int
864dbfa3 1901Perl_magic_setnkeys(pTHX_ SV *sv, MAGIC *mg)
946ec16e 1902{
7918f24d 1903 PERL_ARGS_ASSERT_MAGIC_SETNKEYS;
8772537c 1904 PERL_UNUSED_ARG(mg);
946ec16e 1905 if (LvTARG(sv)) {
85fbaab2 1906 hv_ksplit(MUTABLE_HV(LvTARG(sv)), SvIV(sv));
946ec16e
PP
1907 }
1908 return 0;
ac27b0f5 1909}
946ec16e 1910
efaf3674
DM
1911/*
1912=for apidoc magic_methcall
1913
1914Invoke a magic method (like FETCH).
1915
2baee27b
FC
1916C<sv> and C<mg> are the tied thingy and the tie magic.
1917
1918C<meth> is the name of the method to call.
1919
1920C<argc> is the number of args (in addition to $self) to pass to the method.
1921
1922The C<flags> can be:
1923
1924 G_DISCARD invoke method with G_DISCARD flag and don't
1925 return a value
1926 G_UNDEF_FILL fill the stack with argc pointers to
1927 PL_sv_undef
1928
1929The arguments themselves are any values following the C<flags> argument.
efaf3674 1930
796b6530 1931Returns the SV (if any) returned by the method, or C<NULL> on failure.
efaf3674
DM
1932
1933
1934=cut
1935*/
1936
1937SV*
36925d9e 1938Perl_magic_methcall(pTHX_ SV *sv, const MAGIC *mg, SV *meth, U32 flags,
046b0c7d 1939 U32 argc, ...)
a0d0e21e
LW
1940{
1941 dSP;
efaf3674 1942 SV* ret = NULL;
463ee0b2 1943
7918f24d
NC
1944 PERL_ARGS_ASSERT_MAGIC_METHCALL;
1945
efaf3674 1946 ENTER;
d1d7a15d
NC
1947
1948 if (flags & G_WRITING_TO_STDERR) {
1949 SAVETMPS;
1950
2782061f 1951 save_re_context();
d1d7a15d
NC
1952 SAVESPTR(PL_stderrgv);
1953 PL_stderrgv = NULL;
1954 }
1955
efaf3674 1956 PUSHSTACKi(PERLSI_MAGIC);
924508f0 1957 PUSHMARK(SP);
efaf3674 1958
052a7c76
DM
1959 /* EXTEND() expects a signed argc; don't wrap when casting */
1960 assert(argc <= I32_MAX);
1961 EXTEND(SP, (I32)argc+1);
67549bd2
NC
1962 PUSHs(SvTIED_obj(sv, mg));
1963 if (flags & G_UNDEF_FILL) {
1964 while (argc--) {
efaf3674 1965 PUSHs(&PL_sv_undef);
93965878 1966 }
67549bd2 1967 } else if (argc > 0) {
046b0c7d
NC
1968 va_list args;
1969 va_start(args, argc);
1970
1971 do {
35bc1e35
JK
1972 SV *const this_sv = va_arg(args, SV *);
1973 PUSHs(this_sv);
046b0c7d
NC
1974 } while (--argc);
1975
1976 va_end(args);
88e89b8a 1977 }
463ee0b2 1978 PUTBACK;
efaf3674 1979 if (flags & G_DISCARD) {
36925d9e 1980 call_sv(meth, G_SCALAR|G_DISCARD|G_METHOD_NAMED);
efaf3674
DM
1981 }
1982 else {
36925d9e 1983 if (call_sv(meth, G_SCALAR|G_METHOD_NAMED))
efaf3674
DM
1984 ret = *PL_stack_sp--;
1985 }
1986 POPSTACK;
d1d7a15d
NC
1987 if (flags & G_WRITING_TO_STDERR)
1988 FREETMPS;
efaf3674
DM
1989 LEAVE;
1990 return ret;
1991}
1992
efaf3674 1993/* wrapper for magic_methcall that creates the first arg */
463ee0b2 1994
efaf3674 1995STATIC SV*
36925d9e 1996S_magic_methcall1(pTHX_ SV *sv, const MAGIC *mg, SV *meth, U32 flags,
efaf3674
DM
1997 int n, SV *val)
1998{
efaf3674
DM
1999 SV* arg1 = NULL;
2000
2001 PERL_ARGS_ASSERT_MAGIC_METHCALL1;
2002
2003 if (mg->mg_ptr) {
2004 if (mg->mg_len >= 0) {
db4b3a1d 2005 arg1 = newSVpvn_flags(mg->mg_ptr, mg->mg_len, SVs_TEMP);
efaf3674
DM
2006 }
2007 else if (mg->mg_len == HEf_SVKEY)
2008 arg1 = MUTABLE_SV(mg->mg_ptr);
2009 }
2010 else if (mg->mg_type == PERL_MAGIC_tiedelem) {
db4b3a1d 2011 arg1 = newSViv((IV)(mg->mg_len));
efaf3674
DM
2012 sv_2mortal(arg1);
2013 }
2014 if (!arg1) {
046b0c7d 2015 return Perl_magic_methcall(aTHX_ sv, mg, meth, flags, n - 1, val);
efaf3674 2016 }
046b0c7d 2017 return Perl_magic_methcall(aTHX_ sv, mg, meth, flags, n, arg1, val);
946ec16e
PP
2018}
2019
76e3520e 2020STATIC int
36925d9e 2021S_magic_methpack(pTHX_ SV *sv, const MAGIC *mg, SV *meth)
a0d0e21e 2022{
efaf3674 2023 SV* ret;
463ee0b2 2024
7918f24d
NC
2025 PERL_ARGS_ASSERT_MAGIC_METHPACK;
2026
efaf3674
DM
2027 ret = magic_methcall1(sv, mg, meth, 0, 1, NULL);
2028 if (ret)
2029 sv_setsv(sv, ret);
a0d0e21e
LW
2030 return 0;
2031}
463ee0b2 2032
a0d0e21e 2033int
864dbfa3 2034Perl_magic_getpack(pTHX_ SV *sv, MAGIC *mg)
a0d0e21e 2035{
7918f24d
NC
2036 PERL_ARGS_ASSERT_MAGIC_GETPACK;
2037
fd69380d 2038 if (mg->mg_type == PERL_MAGIC_tiedelem)
a0d0e21e 2039 mg->mg_flags |= MGf_GSKIP;
36925d9e 2040 magic_methpack(sv,mg,SV_CONST(FETCH));
463ee0b2
LW
2041 return 0;
2042}
2043
2044int
864dbfa3 2045Perl_magic_setpack(pTHX_ SV *sv, MAGIC *mg)
e336de0d 2046{
b112cff9
DM
2047 MAGIC *tmg;
2048 SV *val;
7918f24d
NC
2049
2050 PERL_ARGS_ASSERT_MAGIC_SETPACK;
2051
b112cff9
DM
2052 /* in the code C<$tied{foo} = $val>, the "thing" that gets passed to
2053 * STORE() is not $val, but rather a PVLV (the sv in this call), whose
2054 * public flags indicate its value based on copying from $val. Doing
2055 * mg_set() on the PVLV temporarily does SvMAGICAL_off(), then calls us.
2056 * So STORE()'s $_[2] arg is a temporarily disarmed PVLV. This goes
2057 * wrong if $val happened to be tainted, as sv hasn't got magic
2058 * enabled, even though taint magic is in the chain. In which case,
2059 * fake up a temporary tainted value (this is easier than temporarily
2060 * re-enabling magic on sv). */
2061
284167a5 2062 if (TAINTING_get && (tmg = mg_find(sv, PERL_MAGIC_taint))
b112cff9
DM
2063 && (tmg->mg_len & 1))
2064 {
2065 val = sv_mortalcopy(sv);
2066 SvTAINTED_on(val);
2067 }
2068 else
2069 val = sv;
2070
36925d9e 2071 magic_methcall1(sv, mg, SV_CONST(STORE), G_DISCARD, 2, val);
463ee0b2
LW
2072 return 0;
2073}
2074
2075int
864dbfa3 2076Perl_magic_clearpack(pTHX_ SV *sv, MAGIC *mg)
463ee0b2 2077{
7918f24d
NC
2078 PERL_ARGS_ASSERT_MAGIC_CLEARPACK;
2079
4c13be3f 2080 if (mg->mg_type == PERL_MAGIC_tiedscalar) return 0;
36925d9e 2081 return magic_methpack(sv,mg,SV_CONST(DELETE));
a0d0e21e 2082}
463ee0b2 2083
93965878
NIS
2084
2085U32
864dbfa3 2086Perl_magic_sizepack(pTHX_ SV *sv, MAGIC *mg)
ac27b0f5 2087{
22846ab4 2088 I32 retval = 0;
efaf3674 2089 SV* retsv;
93965878 2090
7918f24d
NC
2091 PERL_ARGS_ASSERT_MAGIC_SIZEPACK;
2092
36925d9e 2093 retsv = magic_methcall1(sv, mg, SV_CONST(FETCHSIZE), 0, 1, NULL);
efaf3674
DM
2094 if (retsv) {
2095 retval = SvIV(retsv)-1;
22846ab4
AB
2096 if (retval < -1)
2097 Perl_croak(aTHX_ "FETCHSIZE returned a negative value");
93965878 2098 }
22846ab4 2099 return (U32) retval;
93965878
NIS
2100}
2101
cea2e8a9
GS
2102int
2103Perl_magic_wipepack(pTHX_ SV *sv, MAGIC *mg)
a0d0e21e 2104{
7918f24d
NC
2105 PERL_ARGS_ASSERT_MAGIC_WIPEPACK;
2106
36925d9e 2107 Perl_magic_methcall(aTHX_ sv, mg, SV_CONST(CLEAR), G_DISCARD, 0);
463ee0b2
LW
2108 return 0;
2109}
2110
2111int
864dbfa3 2112Perl_magic_nextpack(pTHX_ SV *sv, MAGIC *mg, SV *key)
463ee0b2 2113{
efaf3674 2114 SV* ret;
463ee0b2 2115
7918f24d
NC
2116 PERL_ARGS_ASSERT_MAGIC_NEXTPACK;
2117
36925d9e
RZ
2118 ret = SvOK(key) ? Perl_magic_methcall(aTHX_ sv, mg, SV_CONST(NEXTKEY), 0, 1, key)
2119 : Perl_magic_methcall(aTHX_ sv, mg, SV_CONST(FIRSTKEY), 0, 0);
efaf3674
DM
2120 if (ret)
2121 sv_setsv(key,ret);
79072805
LW
2122 return 0;
2123}
2124
2125int
1146e912 2126Perl_magic_existspack(pTHX_ SV *sv, const MAGIC *mg)
a0d0e21e 2127{
7918f24d
NC
2128 PERL_ARGS_ASSERT_MAGIC_EXISTSPACK;
2129
36925d9e 2130 return magic_methpack(sv,mg,SV_CONST(EXISTS));
ac27b0f5 2131}
a0d0e21e 2132
a3bcc51e
TP
2133SV *
2134Perl_magic_scalarpack(pTHX_ HV *hv, MAGIC *mg)
2135{
5fcbf73d 2136 SV *retval;
ad64d0ec
NC
2137 SV * const tied = SvTIED_obj(MUTABLE_SV(hv), mg);
2138 HV * const pkg = SvSTASH((const SV *)SvRV(tied));
a3bcc51e 2139
7918f24d
NC
2140 PERL_ARGS_ASSERT_MAGIC_SCALARPACK;
2141
a3bcc51e
TP
2142 if (!gv_fetchmethod_autoload(pkg, "SCALAR", FALSE)) {
2143 SV *key;
bfcb3514 2144 if (HvEITER_get(hv))
a3bcc51e
TP
2145 /* we are in an iteration so the hash cannot be empty */
2146 return &PL_sv_yes;
2147 /* no xhv_eiter so now use FIRSTKEY */
2148 key = sv_newmortal();
ad64d0ec 2149 magic_nextpack(MUTABLE_SV(hv), mg, key);
bfcb3514 2150 HvEITER_set(hv, NULL); /* need to reset iterator */
a3bcc51e
TP
2151 return SvOK(key) ? &PL_sv_yes : &PL_sv_no;
2152 }
2153
2154 /* there is a SCALAR method that we can call */
36925d9e 2155 retval = Perl_magic_methcall(aTHX_ MUTABLE_SV(hv), mg, SV_CONST(SCALAR), 0, 0);
efaf3674 2156 if (!retval)
5fcbf73d 2157 retval = &PL_sv_undef;
a3bcc51e
TP
2158 return retval;
2159}
2160
a0d0e21e 2161int
864dbfa3 2162Perl_magic_setdbline(pTHX_ SV *sv, MAGIC *mg)
79072805 2163{
089b5c60 2164 SV **svp;
7918f24d
NC
2165
2166 PERL_ARGS_ASSERT_MAGIC_SETDBLINE;
2167
089b5c60
NC
2168 /* The magic ptr/len for the debugger's hash should always be an SV. */
2169 if (UNLIKELY(mg->mg_len != HEf_SVKEY)) {
147e3846 2170 Perl_croak(aTHX_ "panic: magic_setdbline len=%" IVdf ", ptr='%s'",
7b0eb0b8 2171 (IV)mg->mg_len, mg->mg_ptr);
089b5c60
NC
2172 }
2173
2174 /* Use sv_2iv instead of SvIV() as the former generates smaller code, and
2175 setting/clearing debugger breakpoints is not a hot path. */
43e4250a
FC
2176 svp = av_fetch(MUTABLE_AV(mg->mg_obj),
2177 sv_2iv(MUTABLE_SV((mg)->mg_ptr)), FALSE);
089b5c60 2178
8772537c 2179 if (svp && SvIOKp(*svp)) {
88df5f01
FC
2180 OP * const o = INT2PTR(OP*,SvIVX(*svp));
2181 if (o) {
2182#ifdef PERL_DEBUG_READONLY_OPS
2183 Slab_to_rw(OpSLAB(o));
2184#endif
2185 /* set or clear breakpoint in the relevant control op */
089b5c60 2186 if (SvTRUE(sv))
88df5f01 2187 o->op_flags |= OPf_SPECIAL;
8772537c 2188 else
88df5f01
FC
2189 o->op_flags &= ~OPf_SPECIAL;
2190#ifdef PERL_DEBUG_READONLY_OPS
2191 Slab_to_ro(OpSLAB(o));
2192#endif
8772537c 2193 }
5df8de69 2194 }
79072805
LW
2195 return 0;
2196}
2197
2198int
8772537c 2199Perl_magic_getarylen(pTHX_ SV *sv, const MAGIC *mg)
79072805 2200{
502c6561 2201 AV * const obj = MUTABLE_AV(mg->mg_obj);
7918f24d
NC
2202
2203 PERL_ARGS_ASSERT_MAGIC_GETARYLEN;
2204
83bf042f 2205 if (obj) {
e1dccc0d 2206 sv_setiv(sv, AvFILL(obj));
83bf042f 2207 } else {
3773545d 2208 sv_set_undef(sv);
83bf042f 2209 }
79072805
LW
2210 return 0;
2211}
2212
2213int
864dbfa3 2214Perl_magic_setarylen(pTHX_ SV *sv, MAGIC *mg)
79072805 2215{
502c6561 2216 AV * const obj = MUTABLE_AV(mg->mg_obj);
7918f24d
NC
2217
2218 PERL_ARGS_ASSERT_MAGIC_SETARYLEN;
2219
83bf042f 2220 if (obj) {
e1dccc0d 2221 av_fill(obj, SvIV(sv));
83bf042f 2222 } else {
a2a5de95
NC
2223 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
2224 "Attempt to set length of freed array");
83bf042f
NC
2225 }
2226 return 0;
2227}
2228
2229int
83f29afa
VP
2230Perl_magic_cleararylen_p(pTHX_ SV *sv, MAGIC *mg)
2231{
83f29afa
VP
2232 PERL_ARGS_ASSERT_MAGIC_CLEARARYLEN_P;
2233 PERL_UNUSED_ARG(sv);
dc3bf405 2234 PERL_UNUSED_CONTEXT;
83f29afa
VP
2235
2236 /* Reset the iterator when the array is cleared */
4803e7f7
Z
2237 if (sizeof(IV) == sizeof(SSize_t)) {
2238 *((IV *) &(mg->mg_len)) = 0;
2239 } else {
2240 if (mg->mg_ptr)
2241 *((IV *) mg->mg_ptr) = 0;
2242 }
83f29afa
VP
2243
2244 return 0;
2245}
2246
2247int
83bf042f
NC
2248Perl_magic_freearylen_p(pTHX_ SV *sv, MAGIC *mg)
2249{
7918f24d 2250 PERL_ARGS_ASSERT_MAGIC_FREEARYLEN_P;
53c1dcc0 2251 PERL_UNUSED_ARG(sv);
7918f24d 2252
94f3782b
DM
2253 /* during global destruction, mg_obj may already have been freed */
2254 if (PL_in_clean_all)
1ea47f64 2255 return 0;
94f3782b 2256
83bf042f
NC
2257 mg = mg_find (mg->mg_obj, PERL_MAGIC_arylen);
2258
2259 if (mg) {
2260 /* arylen scalar holds a pointer back to the array, but doesn't own a
2261 reference. Hence the we (the array) are about to go away with it
2262 still pointing at us. Clear its pointer, else it would be pointing
2263 at free memory. See the comment in sv_magic about reference loops,
2264 and why it can't own a reference to us. */
2265 mg->mg_obj = 0;
2266 }
a0d0e21e
LW
2267 return 0;
2268}
2269
2270int
864dbfa3 2271Perl_magic_getpos(pTHX_ SV *sv, MAGIC *mg)
a0d0e21e 2272{
16eb5365 2273 SV* const lsv = LvTARG(sv);
96c2a8ff 2274 MAGIC * const found = mg_find_mglob(lsv);
7918f24d
NC
2275
2276 PERL_ARGS_ASSERT_MAGIC_GETPOS;
16eb5365 2277 PERL_UNUSED_ARG(mg);
ac27b0f5 2278
6174b39a
FC
2279 if (found && found->mg_len != -1) {
2280 STRLEN i = found->mg_len;
25fdce4a 2281 if (found->mg_flags & MGf_BYTES && DO_UTF8(lsv))
6174b39a
FC
2282 i = sv_pos_b2u_flags(lsv, i, SV_GMAGIC|SV_CONST_RETURN);
2283 sv_setuv(sv, i);
a0d0e21e 2284 return 0;
a0d0e21e 2285 }
3773545d 2286 sv_set_undef(sv);
a0d0e21e
LW
2287 return 0;
2288}
2289
2290int
864dbfa3 2291Perl_magic_setpos(pTHX_ SV *sv, MAGIC *mg)
a0d0e21e 2292{
16eb5365 2293 SV* const lsv = LvTARG(sv);
a0d0e21e
LW
2294 SSize_t pos;
2295 STRLEN len;
53d44271 2296 MAGIC* found;
aec43834 2297 const char *s;
a0d0e21e 2298
7918f24d 2299 PERL_ARGS_ASSERT_MAGIC_SETPOS;
16eb5365 2300 PERL_UNUSED_ARG(mg);
ac27b0f5 2301
96c2a8ff 2302 found = mg_find_mglob(lsv);
3881461a 2303 if (!found) {
a0d0e21e
LW
2304 if (!SvOK(sv))
2305 return 0;
96c2a8ff 2306 found = sv_magicext_mglob(lsv);
a0d0e21e
LW
2307 }
2308 else if (!SvOK(sv)) {
3881461a 2309 found->mg_len = -1;
a0d0e21e
LW
2310 return 0;
2311 }
aec43834 2312 s = SvPV_const(lsv, len);
a0d0e21e 2313
e1dccc0d 2314 pos = SvIV(sv);
a0ed51b3 2315
7e2040f0 2316 if (DO_UTF8(lsv)) {
19742f39 2317 const STRLEN ulen = sv_or_pv_len_utf8(lsv, s, len);
a0ed51b3
LW
2318 if (ulen)
2319 len = ulen;
a0ed51b3
LW
2320 }
2321
a0d0e21e
LW
2322 if (pos < 0) {
2323 pos += len;
2324 if (pos < 0)
2325 pos = 0;
2326 }
eb160463 2327 else if (pos > (SSize_t)len)
a0d0e21e 2328 pos = len;
a0ed51b3 2329
3881461a 2330 found->mg_len = pos;
25fdce4a 2331 found->mg_flags &= ~(MGf_MINMATCH|MGf_BYTES);
a0d0e21e 2332
79072805
LW
2333 return 0;
2334}
2335
2336int
864dbfa3 2337Perl_magic_getsubstr(pTHX_ SV *sv, MAGIC *mg)
6ff81951
GS
2338{
2339 STRLEN len;
35a4481c 2340 SV * const lsv = LvTARG(sv);
b83604b4 2341 const char * const tmps = SvPV_const(lsv,len);
777f7c56
EB
2342 STRLEN offs = LvTARGOFF(sv);
2343 STRLEN rem = LvTARGLEN(sv);
b063b0a8
DIM
2344 const bool negoff = LvFLAGS(sv) & LVf_NEG_OFF;
2345 const bool negrem = LvFLAGS(sv) & LVf_NEG_LEN;
7918f24d
NC
2346
2347 PERL_ARGS_ASSERT_MAGIC_GETSUBSTR;
8772537c 2348 PERL_UNUSED_ARG(mg);
6ff81951 2349
83f78d1a 2350 if (!translate_substr_offsets(
4ddea69a 2351 SvUTF8(lsv) ? sv_or_pv_len_utf8(lsv, tmps, len) : len,
83f78d1a
FC
2352 negoff ? -(IV)offs : (IV)offs, !negoff,
2353 negrem ? -(IV)rem : (IV)rem, !negrem, &offs, &rem
2354 )) {
2355 Perl_ck_warner(aTHX_ packWARN(WARN_SUBSTR), "substr outside of string");
e03e82a0 2356 sv_set_undef(sv);
83f78d1a
FC
2357 return 0;
2358 }
2359
9aa983d2 2360 if (SvUTF8(lsv))
4ddea69a 2361 offs = sv_or_pv_pos_u2b(lsv, tmps, offs, &rem);
1c900557 2362 sv_setpvn(sv, tmps + offs, rem);
9aa983d2 2363 if (SvUTF8(lsv))
2ef4b674 2364 SvUTF8_on(sv);
6ff81951
GS
2365 return 0;
2366}
2367
2368int
864dbfa3 2369Perl_magic_setsubstr(pTHX_ SV *sv, MAGIC *mg)
79072805 2370{
83f78d1a 2371 STRLEN len, lsv_len, oldtarglen, newtarglen;
5fcbf73d 2372 const char * const tmps = SvPV_const(sv, len);
dd374669 2373 SV * const lsv = LvTARG(sv);
777f7c56
EB
2374 STRLEN lvoff = LvTARGOFF(sv);
2375 STRLEN lvlen = LvTARGLEN(sv);
b063b0a8
DIM
2376 const bool negoff = LvFLAGS(sv) & LVf_NEG_OFF;
2377 const bool neglen = LvFLAGS(sv) & LVf_NEG_LEN;
7918f24d
NC
2378
2379 PERL_ARGS_ASSERT_MAGIC_SETSUBSTR;
8772537c 2380 PERL_UNUSED_ARG(mg);
075a4a2b 2381
a74fb2cd
FC
2382 SvGETMAGIC(lsv);
2383 if (SvROK(lsv))
2384 Perl_ck_warner(aTHX_ packWARN(WARN_SUBSTR),
2385 "Attempt to use reference as lvalue in substr"
2386 );
fc061ed8
FC
2387 SvPV_force_nomg(lsv,lsv_len);
2388 if (SvUTF8(lsv)) lsv_len = sv_len_utf8_nomg(lsv);
83f78d1a
FC
2389 if (!translate_substr_offsets(
2390 lsv_len,
2391 negoff ? -(IV)lvoff : (IV)lvoff, !negoff,
2392 neglen ? -(IV)lvlen : (IV)lvlen, !neglen, &lvoff, &lvlen
2393 ))
2394 Perl_croak(aTHX_ "substr outside of string");
2395 oldtarglen = lvlen;
1aa99e6b 2396 if (DO_UTF8(sv)) {
73a087f0 2397 sv_utf8_upgrade_nomg(lsv);
d931b1be 2398 lvoff = sv_pos_u2b_flags(lsv, lvoff, &lvlen, SV_CONST_RETURN);
a74fb2cd 2399 sv_insert_flags(lsv, lvoff, lvlen, tmps, len, 0);
7a385470 2400 newtarglen = sv_or_pv_len_utf8(sv, tmps, len);
9aa983d2
JH
2401 SvUTF8_on(lsv);
2402 }
0d336106 2403 else if (SvUTF8(lsv)) {
5fcbf73d 2404 const char *utf8;
d931b1be 2405 lvoff = sv_pos_u2b_flags(lsv, lvoff, &lvlen, SV_CONST_RETURN);
83f78d1a 2406 newtarglen = len;
5fcbf73d 2407 utf8 = (char*)bytes_to_utf8((U8*)tmps, &len);
a74fb2cd 2408 sv_insert_flags(lsv, lvoff, lvlen, utf8, len, 0);
5fcbf73d 2409 Safefree(utf8);
1aa99e6b 2410 }
b76f3ce2 2411 else {
a74fb2cd 2412 sv_insert_flags(lsv, lvoff, lvlen, tmps, len, 0);
83f78d1a 2413 newtarglen = len;
b76f3ce2 2414 }
83f78d1a
FC
2415 if (!neglen) LvTARGLEN(sv) = newtarglen;
2416 if (negoff) LvTARGOFF(sv) += newtarglen - oldtarglen;
b76f3ce2 2417
79072805
LW
2418 return 0;
2419}
2420
2421int
864dbfa3 2422Perl_magic_gettaint(pTHX_ SV *sv, MAGIC *mg)
463ee0b2 2423{
7918f24d 2424 PERL_ARGS_ASSERT_MAGIC_GETTAINT;
8772537c 2425 PERL_UNUSED_ARG(sv);
9a9b5ec9
DM
2426#ifdef NO_TAINT_SUPPORT
2427 PERL_UNUSED_ARG(mg);
2428#endif
7918f24d 2429
64ff300b 2430 TAINT_IF((PL_localizing != 1) && (mg->mg_len & 1) && IN_PERL_RUNTIME);
463ee0b2
LW
2431 return 0;
2432}
2433
2434int
864dbfa3 2435Perl_magic_settaint(pTHX_ SV *sv, MAGIC *mg)
463ee0b2 2436{
7918f24d 2437 PERL_ARGS_ASSERT_MAGIC_SETTAINT;
8772537c 2438 PERL_UNUSED_ARG(sv);
7918f24d 2439
b01e650a 2440 /* update taint status */
284167a5 2441 if (TAINT_get)
b01e650a
DM
2442 mg->mg_len |= 1;
2443 else
2444 mg->mg_len &= ~1;
463ee0b2
LW
2445 return 0;
2446}
2447
2448int
864dbfa3 2449Perl_magic_getvec(pTHX_ SV *sv, MAGIC *mg)
6ff81951 2450{
35a4481c 2451 SV * const lsv = LvTARG(sv);
1b92e694 2452 char errflags = LvFLAGS(sv);
7918f24d
NC
2453
2454 PERL_ARGS_ASSERT_MAGIC_GETVEC;
8772537c 2455 PERL_UNUSED_ARG(mg);
6ff81951 2456
1b92e694 2457 /* non-zero errflags implies deferred out-of-range condition */
b063b0a8 2458 assert(!(errflags & ~(LVf_NEG_OFF|LVf_OUT_OF_RANGE)));
1b92e694 2459 sv_setuv(sv, errflags ? 0 : do_vecget(lsv, LvTARGOFF(sv), LvTARGLEN(sv)));
6ff81951 2460
6ff81951
GS
2461 return 0;
2462}
2463
2464int
864dbfa3 2465Perl_magic_setvec(pTHX_ SV *sv, MAGIC *mg)
79072805 2466{
7918f24d 2467 PERL_ARGS_ASSERT_MAGIC_SETVEC;
8772537c 2468 PERL_UNUSED_ARG(mg);
79072805
LW
2469 do_vecset(sv); /* XXX slurp this routine */
2470 return 0;
2471}
2472
13733cde
FC
2473SV *
2474Perl_defelem_target(pTHX_ SV *sv, MAGIC *mg)
5f05dabc 2475{
a0714e2c 2476 SV *targ = NULL;
13733cde
FC
2477 PERL_ARGS_ASSERT_DEFELEM_TARGET;
2478 if (!mg) mg = mg_find(sv, PERL_MAGIC_defelem);
2479 assert(mg);
5f05dabc 2480 if (LvTARGLEN(sv)) {
68dc0745 2481 if (mg->mg_obj) {
8772537c 2482 SV * const ahv = LvTARG(sv);
85fbaab2 2483 HE * const he = hv_fetch_ent(MUTABLE_HV(ahv), mg->mg_obj, FALSE, 0);
6d822dc4
MS
2484 if (he)
2485 targ = HeVAL(he);
68dc0745 2486 }
bbfdc870 2487 else if (LvSTARGOFF(sv) >= 0) {
502c6561 2488 AV *const av = MUTABLE_AV(LvTARG(sv));
bbfdc870 2489 if (LvSTARGOFF(sv) <= AvFILL(av))
ca58dfd9
FC
2490 {
2491 if (SvRMAGICAL(av)) {
2492 SV * const * const svp = av_fetch(av, LvSTARGOFF(sv), 0);
2493 targ = svp ? *svp : NULL;
2494 }
2495 else
bbfdc870 2496 targ = AvARRAY(av)[LvSTARGOFF(sv)];
ca58dfd9 2497 }
68dc0745 2498 }
46da273f 2499 if (targ && (targ != &PL_sv_undef)) {
68dc0745
PP
2500 /* somebody else defined it for us */
2501 SvREFCNT_dec(LvTARG(sv));
b37c2d43 2502 LvTARG(sv) = SvREFCNT_inc_simple_NN(targ);
68dc0745
PP
2503 LvTARGLEN(sv) = 0;
2504 SvREFCNT_dec(mg->mg_obj);
a0714e2c 2505 mg->mg_obj = NULL;
68dc0745
PP
2506 mg->mg_flags &= ~MGf_REFCOUNTED;
2507 }
13733cde 2508 return targ;
5f05dabc 2509 }
71be2cbc 2510 else
13733cde
FC
2511 return LvTARG(sv);
2512}
2513
2514int
2515Perl_magic_getdefelem(pTHX_ SV *sv, MAGIC *mg)
2516{
2517 PERL_ARGS_ASSERT_MAGIC_GETDEFELEM;
2518
2519 sv_setsv(sv, defelem_target(sv, mg));
71be2cbc
PP
2520 return 0;
2521}
2522
2523int
864dbfa3 2524Perl_magic_setdefelem(pTHX_ SV *sv, MAGIC *mg)
71be2cbc 2525{
7918f24d 2526 PERL_ARGS_ASSERT_MAGIC_SETDEFELEM;
8772537c 2527 PERL_UNUSED_ARG(mg);
71be2cbc 2528 if (LvTARGLEN(sv))
68dc0745
PP
2529 vivify_defelem(sv);
2530 if (LvTARG(sv)) {
5f05dabc 2531 sv_setsv(LvTARG(sv), sv);
68dc0745
PP
2532 SvSETMAGIC(LvTARG(sv));
2533 }
5f05dabc
PP
2534 return 0;
2535}
2536
71be2cbc 2537void
864dbfa3 2538Perl_vivify_defelem(pTHX_ SV *sv)
71be2cbc 2539{
74e13ce4 2540 MAGIC *mg;
a0714e2c 2541 SV *value = NULL;
71be2cbc 2542
7918f24d
NC
2543 PERL_ARGS_ASSERT_VIVIFY_DEFELEM;
2544
14befaf4 2545 if (!LvTARGLEN(sv) || !(mg = mg_find(sv, PERL_MAGIC_defelem)))
71be2cbc 2546 return;
68dc0745 2547 if (mg->mg_obj) {
8772537c 2548 SV * const ahv = LvTARG(sv);
85fbaab2 2549 HE * const he = hv_fetch_ent(MUTABLE_HV(ahv), mg->mg_obj, TRUE, 0);
6d822dc4
MS
2550 if (he)
2551 value = HeVAL(he);
3280af22 2552 if (!value || value == &PL_sv_undef)
be2597df 2553 Perl_croak(aTHX_ PL_no_helem_sv, SVfARG(mg->mg_obj));
71be2cbc 2554 }
bbfdc870
FC
2555 else if (LvSTARGOFF(sv) < 0)
2556 Perl_croak(aTHX_ PL_no_aelem, LvSTARGOFF(sv));
68dc0745 2557 else {
502c6561 2558 AV *const av = MUTABLE_AV(LvTARG(sv));
bbfdc870 2559 if ((I32)LvTARGLEN(sv) < 0 && LvSTARGOFF(sv) > AvFILL(av))
a0714e2c 2560 LvTARG(sv) = NULL; /* array can't be extended */
68dc0745 2561 else {
bbfdc870 2562 SV* const * const svp = av_fetch(av, LvSTARGOFF(sv), TRUE);
031c6d82 2563 if (!svp || !(value = *svp))
bbfdc870 2564 Perl_croak(aTHX_ PL_no_aelem, LvSTARGOFF(sv));
68dc0745
PP
2565 }
2566 }
b37c2d43 2567 SvREFCNT_inc_simple_void(value);
68dc0745
PP
2568 SvREFCNT_dec(LvTARG(sv));
2569 LvTARG(sv) = value;
71be2cbc 2570 LvTARGLEN(sv) = 0;
68dc0745 2571 SvREFCNT_dec(mg->mg_obj);
a0714e2c 2572 mg->mg_obj = NULL;
68dc0745 2573 mg->mg_flags &= ~MGf_REFCOUNTED;
5f05dabc
PP
2574}
2575
2576int
1f1dcfb5
FC
2577Perl_magic_setnonelem(pTHX_ SV *sv, MAGIC *mg)
2578{
2579 PERL_ARGS_ASSERT_MAGIC_SETNONELEM;
2580 PERL_UNUSED_ARG(mg);
2581 sv_unmagic(sv, PERL_MAGIC_nonelem);
2582 return 0;
2583}
2584
2585int
864dbfa3 2586Perl_magic_killbackrefs(pTHX_ SV *sv, MAGIC *mg)
810b8aa5 2587{
7918f24d 2588 PERL_ARGS_ASSERT_MAGIC_KILLBACKREFS;
5648c0ae
DM
2589 Perl_sv_kill_backrefs(aTHX_ sv, MUTABLE_AV(mg->mg_obj));
2590 return 0;
810b8aa5
GS
2591}
2592
2593int
864dbfa3 2594Perl_magic_setmglob(pTHX_ SV *sv, MAGIC *mg)
93a17b20 2595{
7918f24d 2596 PERL_ARGS_ASSERT_MAGIC_SETMGLOB;
96a5add6 2597 PERL_UNUSED_CONTEXT;
0177730e 2598 PERL_UNUSED_ARG(sv);
565764a8 2599 mg->mg_len = -1;
93a17b20
LW
2600 return 0;
2601}
2602
2603int
864dbfa3 2604Perl_magic_setuvar(pTHX_ SV *sv, MAGIC *mg)
79072805 2605{
35a4481c 2606 const struct ufuncs * const uf = (struct ufuncs *)mg->mg_ptr;
79072805 2607
7918f24d
NC
2608 PERL_ARGS_ASSERT_MAGIC_SETUVAR;
2609
79072805 2610 if (uf && uf->uf_set)
24f81a43 2611 (*uf->uf_set)(aTHX_ uf->uf_index, sv);
79072805
LW
2612 return 0;
2613}
2614
c277df42 2615int
faf82a0b
AE
2616Perl_magic_setregexp(pTHX_ SV *sv, MAGIC *mg)
2617{
488344d2 2618 const char type = mg->mg_type;
7918f24d
NC
2619
2620 PERL_ARGS_ASSERT_MAGIC_SETREGEXP;
2621
a5c7cb08
DM
2622 assert( type == PERL_MAGIC_fm
2623 || type == PERL_MAGIC_qr
2624 || type == PERL_MAGIC_bm);
488344d2 2625 return sv_unmagic(sv, type);
faf82a0b
AE
2626}
2627
7a4c00b4 2628#ifdef USE_LOCALE_COLLATE
79072805 2629int
864dbfa3 2630Perl_magic_setcollxfrm(pTHX_ SV *sv, MAGIC *mg)
bbce6d69 2631{
7918f24d
NC
2632 PERL_ARGS_ASSERT_MAGIC_SETCOLLXFRM;
2633
bbce6d69 2634 /*
838b5b74 2635 * RenE<eacute> Descartes said "I think not."
bbce6d69
PP
2636 * and vanished with a faint plop.
2637 */
96a5add6 2638 PERL_UNUSED_CONTEXT;
8772537c 2639 PERL_UNUSED_ARG(sv);
7a4c00b4
PP
2640 if (mg->mg_ptr) {
2641 Safefree(mg->mg_ptr);
2642 mg->mg_ptr = NULL;
565764a8 2643 mg->mg_len = -1;
7a4c00b4 2644 }
bbce6d69
PP
2645 return 0;
2646}
7a4c00b4 2647#endif /* USE_LOCALE_COLLATE */
bbce6d69 2648
7e8c5dac
HS
2649/* Just clear the UTF-8 cache data. */
2650int
2651Perl_magic_setutf8(pTHX_ SV *sv, MAGIC *mg)
2652{
7918f24d 2653 PERL_ARGS_ASSERT_MAGIC_SETUTF8;
96a5add6 2654 PERL_UNUSED_CONTEXT;
8772537c 2655 PERL_UNUSED_ARG(sv);
7e8c5dac 2656 Safefree(mg->mg_ptr); /* The mg_ptr holds the pos cache. */
3881461a 2657 mg->mg_ptr = NULL;
7e8c5dac
HS
2658 mg->mg_len = -1; /* The mg_len holds the len cache. */
2659 return 0;
2660}
2661
bbce6d69 2662int
9cce4f9a
FC
2663Perl_magic_setlvref(pTHX_ SV *sv, MAGIC *mg)
2664{
9782ce69 2665 const char *bad = NULL;
9cce4f9a 2666 PERL_ARGS_ASSERT_MAGIC_SETLVREF;
26a50d99 2667 if (!SvROK(sv)) Perl_croak(aTHX_ "Assigned value is not a reference");
9782ce69
FC
2668 switch (mg->mg_private & OPpLVREF_TYPE) {
2669 case OPpLVREF_SV:
2670 if (SvTYPE(SvRV(sv)) > SVt_PVLV)
2671 bad = " SCALAR";
2672 break;
2673 case OPpLVREF_AV:
2674 if (SvTYPE(SvRV(sv)) != SVt_PVAV)
2675 bad = "n ARRAY";
2676 break;
2677 case OPpLVREF_HV:
2678 if (SvTYPE(SvRV(sv)) != SVt_PVHV)
2679 bad = " HASH";
2680 break;
2681 case OPpLVREF_CV:
2682 if (SvTYPE(SvRV(sv)) != SVt_PVCV)
2683 bad = " CODE";
2684 }
2685 if (bad)
26a50d99 2686 /* diag_listed_as: Assigned value is not %s reference */
9782ce69 2687 Perl_croak(aTHX_ "Assigned value is not a%s reference", bad);
c146a62a
FC
2688 switch (mg->mg_obj ? SvTYPE(mg->mg_obj) : 0) {
2689 case 0:
2690 {
2691 SV * const old = PAD_SV(mg->mg_len);
2692 PAD_SETSV(mg->mg_len, SvREFCNT_inc_NN(SvRV(sv)));
2693 SvREFCNT_dec(old);
2694 break;
2695 }
2696 case SVt_PVGV:
2697 gv_setref(mg->mg_obj, sv);
2698 SvSETMAGIC(mg->mg_obj);
6102323a
FC
2699 break;
2700 case SVt_PVAV:
2701 av_store((AV *)mg->mg_obj, SvIV((SV *)mg->mg_ptr),
2702 SvREFCNT_inc_simple_NN(SvRV(sv)));
5f94141d
FC
2703 break;
2704 case SVt_PVHV:
7fcb36d5
JH
2705 (void)hv_store_ent((HV *)mg->mg_obj, (SV *)mg->mg_ptr,
2706 SvREFCNT_inc_simple_NN(SvRV(sv)), 0);
c146a62a 2707 }
d39c26a6
FC
2708 if (mg->mg_flags & MGf_PERSIST)
2709 NOOP; /* This sv is in use as an iterator var and will be reused,
2710 so we must leave the magic. */
2711 else
2712 /* This sv could be returned by the assignment op, so clear the
2713 magic, as lvrefs are an implementation detail that must not be
2714 leaked to the user. */
2715 sv_unmagic(sv, PERL_MAGIC_lvref);
9cce4f9a
FC
2716 return 0;
2717}
2718
f1540bed
JH
2719static void
2720S_set_dollarzero(pTHX_ SV *sv)
2721 PERL_TSA_REQUIRES(PL_dollarzero_mutex)
2722{
2723#ifdef USE_ITHREADS
f1540bed
JH
2724#endif
2725 const char *s;
2726 STRLEN len;
f1540bed
JH
2727#ifdef HAS_SETPROCTITLE
2728 /* The BSDs don't show the argv[] in ps(1) output, they
2729 * show a string from the process struct and provide
2730 * the setproctitle() routine to manipulate that. */
2731 if (PL_origalen != 1) {
2732 s = SvPV_const(sv, len);
38626956 2733# if __FreeBSD_version > 410001 || defined(__DragonFly__)
f1540bed
JH
2734 /* The leading "-" removes the "perl: " prefix,
2735 * but not the "(perl) suffix from the ps(1)
2736 * output, because that's what ps(1) shows if the
2737 * argv[] is modified. */
2738 setproctitle("-%s", s);
2739# else /* old FreeBSDs, NetBSD, OpenBSD, anyBSD */
2740 /* This doesn't really work if you assume that
2741 * $0 = 'foobar'; will wipe out 'perl' from the $0
2742 * because in ps(1) output the result will be like
2743 * sprintf("perl: %s (perl)", s)
2744 * I guess this is a security feature:
2745 * one (a user process) cannot get rid of the original name.
2746 * --jhi */
2747 setproctitle("%s", s);
2748# endif
2749 }
2750#elif defined(__hpux) && defined(PSTAT_SETCMD)
2751 if (PL_origalen != 1) {
2752 union pstun un;
2753 s = SvPV_const(sv, len);
2754 un.pst_command = (char *)s;
2755 pstat(PSTAT_SETCMD, un, len, 0, 0);
2756 }
2757#else
2758 if (PL_origalen > 1) {
4f3e04fd 2759 I32 i;
f1540bed
JH
2760 /* PL_origalen is set in perl_parse(). */
2761 s = SvPV_force(sv,len);
2762 if (len >= (STRLEN)PL_origalen-1) {
2763 /* Longer than original, will be truncated. We assume that
2764 * PL_origalen bytes are available. */
2765 Copy(s, PL_origargv[0], PL_origalen-1, char);
2766 }
2767 else {
2768 /* Shorter than original, will be padded. */
2769#ifdef PERL_DARWIN
2770 /* Special case for Mac OS X: see [perl #38868] */
2771 const int pad = 0;
2772#else
2773 /* Is the space counterintuitive? Yes.
2774 * (You were expecting \0?)
2775 * Does it work? Seems to. (In Linux 2.4.20 at least.)
2776 * --jhi */
2777 const int pad = ' ';
2778#endif
2779 Copy(s, PL_origargv[0], len, char);
2780 PL_origargv[0][len] = 0;
2781 memset(PL_origargv[0] + len + 1,
2782 pad, PL_origalen - len - 1);
2783 }
2784 PL_origargv[0][PL_origalen-1] = 0;
2785 for (i = 1; i < PL_origargc; i++)
2786 PL_origargv[i] = 0;
2787#ifdef HAS_PRCTL_SET_NAME
2788 /* Set the legacy process name in addition to the POSIX name on Linux */
2789 if (prctl(PR_SET_NAME, (unsigned long)s, 0, 0, 0) != 0) {
2790 /* diag_listed_as: SKIPME */
2791 Perl_croak(aTHX_ "Can't set $0 with prctl(): %s", Strerror(errno));
2792 }
2793#endif
2794 }
2795#endif
2796}
2797
9cce4f9a 2798int
864dbfa3 2799Perl_magic_set(pTHX_ SV *sv, MAGIC *mg)
79072805 2800{
20b7effb 2801#ifdef USE_ITHREADS
20b7effb 2802#endif
eb578fdb
KW
2803 I32 paren;
2804 const REGEXP * rx;
79072805 2805 I32 i;
8990e307 2806 STRLEN len;
125b9982 2807 MAGIC *tmg;
2fdbfb4d 2808
7918f24d
NC
2809 PERL_ARGS_ASSERT_MAGIC_SET;
2810
e91d8259 2811 if (!mg->mg_ptr) {
960b831f 2812 paren = mg->mg_len;
1e05feb3 2813 if (PL_curpm && (rx = PM_GETRE(PL_curpm))) {
e91d8259 2814 setparen_got_rx:
2fdbfb4d 2815 CALLREG_NUMBUF_STORE((REGEXP * const)rx,paren,sv);
1e05feb3 2816 } else {
2fdbfb4d
AB
2817 /* Croak with a READONLY error when a numbered match var is
2818 * set without a previous pattern match. Unless it's C<local $1>
2819 */
e91d8259 2820 croakparen:
2fdbfb4d 2821 if (!PL_localizing) {
cb077ed2 2822 Perl_croak_no_modify();
2fdbfb4d
AB
2823 }
2824 }
e91d8259
NC
2825 return 0;
2826 }
2827
2828 switch (*mg->mg_ptr) {
748a9306 2829 case '\001': /* ^A */
f2da823f
FC
2830 if (SvOK(sv)) sv_copypv(PL_bodytarget, sv);
2831 else SvOK_off(PL_bodytarget);
64eff8b7
DM
2832 FmLINES(PL_bodytarget) = 0;
2833 if (SvPOK(PL_bodytarget)) {
2834 char *s = SvPVX(PL_bodytarget);
0687887e
KW
2835 char *e = SvEND(PL_bodytarget);
2836 while ( ((s = (char *) memchr(s, '\n', e - s))) ) {
64eff8b7
DM
2837 FmLINES(PL_bodytarget)++;
2838 s++;
2839 }
2840 }
125b9982 2841 /* mg_set() has temporarily made sv non-magical */
284167a5 2842 if (TAINTING_get) {
125b9982
NT
2843 if ((tmg = mg_find(sv,PERL_MAGIC_taint)) && tmg->mg_len & 1)
2844 SvTAINTED_on(PL_bodytarget);
2845 else
2846 SvTAINTED_off(PL_bodytarget);
2847 }
748a9306 2848 break;
49460fe6 2849 case '\003': /* ^C */
f2338a2e 2850 PL_minus_c = cBOOL(SvIV(sv));
49460fe6
NIS
2851 break;
2852
79072805 2853 case '\004': /* ^D */
b4ab917c 2854#ifdef DEBUGGING
a9e2d2bf
DM
2855 {
2856 const char *s = SvPV_nolen_const(sv);
2857 PL_debug = get_debug_opts(&s, 0) | DEBUG_TOP_FLAG;
2858 if (DEBUG_x_TEST || DEBUG_B_TEST)
2859 dump_all_perl(!DEBUG_B_TEST);
2860 }
b4ab917c 2861#else
38ab35f8 2862 PL_debug = (SvIV(sv)) | DEBUG_TOP_FLAG;
b4ab917c 2863#endif
79072805 2864 break;
28f23441 2865 case '\005': /* ^E */
d0063567 2866 if (*(mg->mg_ptr+1) == '\0') {
e37778c2 2867#ifdef VMS
38ab35f8 2868 set_vaxc_errno(SvIV(sv));
2abc681d 2869#elif defined(WIN32)
d0063567 2870 SetLastError( SvIV(sv) );
2abc681d 2871#elif defined(OS2)
38ab35f8 2872 os2_setsyserrno(SvIV(sv));
2abc681d 2873#else
d0063567 2874 /* will anyone ever use this? */
38ab35f8 2875 SETERRNO(SvIV(sv), 4);
22fae026 2876#endif
d0063567 2877 }
fd503f5c
DIM
2878 else if (strEQ(mg->mg_ptr + 1, "NCODING") && SvOK(sv))
2879 Perl_croak(aTHX_ "${^ENCODING} is no longer supported");
d0063567 2880 break;
79072805 2881 case '\006': /* ^F */
9f601cf3
TC
2882 if (mg->mg_ptr[1] == '\0') {
2883 PL_maxsysfd = SvIV(sv);
2884 }
79072805 2885 break;
a0d0e21e 2886 case '\010': /* ^H */
efa571ab
KW
2887 {
2888 U32 save_hints = PL_hints;
5d382c25 2889 PL_hints = SvUV(sv);
efa571ab
KW
2890
2891 /* If wasn't UTF-8, and now is, notify the parser */
2892 if ((PL_hints & HINT_UTF8) && ! (save_hints & HINT_UTF8)) {
2893 notify_parser_that_changed_to_utf8();
2894 }
2895 }
a0d0e21e 2896 break;
9d116dd7 2897 case '\011': /* ^I */ /* NOT \t in EBCDIC */
43c5f42d 2898 Safefree(PL_inplace);
bd61b366 2899 PL_inplace = SvOK(sv) ? savesvpv(sv) : NULL;
da78da6e 2900 break;
d9bad346
FC
2901 case '\016': /* ^N */
2902 if (PL_curpm && (rx = PM_GETRE(PL_curpm))
2903 && (paren = RX_LASTCLOSEPAREN(rx))) goto setparen_got_rx;
2904 goto croakparen;
28f23441 2905 case '\017': /* ^O */
ac27b0f5 2906 if (*(mg->mg_ptr+1) == '\0') {
43c5f42d 2907 Safefree(PL_osname);
bd61b366 2908 PL_osname = NULL;
3511154c
DM
2909 if (SvOK(sv)) {
2910 TAINT_PROPER("assigning to $^O");
2e0de35c 2911 PL_osname = savesvpv(sv);
3511154c 2912 }
ac27b0f5
NIS
2913 }
2914 else if (strEQ(mg->mg_ptr, "\017PEN")) {
8b850bd5
NC
2915 STRLEN len;
2916 const char *const start = SvPV(sv, len);
b54fc2b6 2917 const char *out = (const char*)memchr(start, '\0', len);
8b850bd5 2918 SV *tmp;
8b850bd5
NC
2919
2920
2921 PL_compiling.cop_hints |= HINT_LEXICAL_IO_IN | HINT_LEXICAL_IO_OUT;
f747ebd6 2922 PL_hints |= HINT_LEXICAL_IO_IN | HINT_LEXICAL_IO_OUT;
8b850bd5
NC
2923
2924 /* Opening for input is more common than opening for output, so
2925 ensure that hints for input are sooner on linked list. */
59cd0e26 2926 tmp = out ? newSVpvn_flags(out + 1, start + len - out - 1,
f747ebd6
Z
2927 SvUTF8(sv))
2928 : newSVpvs_flags("", SvUTF8(sv));
2929 (void)hv_stores(GvHV(PL_hintgv), "open>", tmp);
2930 mg_set(tmp);
8b850bd5 2931
f747ebd6
Z
2932 tmp = newSVpvn_flags(start, out ? (STRLEN)(out - start) : len,
2933 SvUTF8(sv));
2934 (void)hv_stores(GvHV(PL_hintgv), "open<", tmp);
2935 mg_set(tmp);
ac27b0f5 2936 }
28f23441 2937 break;
79072805 2938 case '\020': /* ^P */
2fdbfb4d
AB
2939 PL_perldb = SvIV(sv);
2940 if (PL_perldb && !PL_DBsingle)
2941 init_debugger();
9b9e0be4 2942 break;
79072805 2943 case '\024': /* ^T */
88e89b8a 2944#ifdef BIG_TIME
6b88bc9c 2945 PL_basetime = (Time_t)(SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv));
88e89b8a 2946#else
38ab35f8 2947 PL_basetime = (Time_t)SvIV(sv);
88e89b8a 2948#endif
79072805 2949 break;
e07ea26a
NC
2950 case '\025': /* ^UTF8CACHE */
2951 if (strEQ(mg->mg_ptr+1, "TF8CACHE")) {
2952 PL_utf8cache = (signed char) sv_2iv(sv);
2953 }
2954 break;
fde18df1 2955 case '\027': /* ^W & $^WARNING_BITS */
4438c4b7
JH
2956 if (*(mg->mg_ptr+1) == '\0') {
2957 if ( ! (PL_dowarn & G_WARN_ALL_MASK)) {
38ab35f8 2958 i = SvIV(sv);
ac27b0f5 2959 PL_dowarn = (PL_dowarn & ~G_WARN_ON)
0453d815 2960 | (i ? G_WARN_ON : G_WARN_OFF) ;
4438c4b7 2961 }
599cee73 2962 }
0a378802 2963 else if (strEQ(mg->mg_ptr+1, "ARNING_BITS")) {
4438c4b7 2964 if ( ! (PL_dowarn & G_WARN_ALL_MASK)) {
7e4f0450 2965 if (!SvPOK(sv)) {
1943af61 2966 free_and_set_cop_warnings(&PL_compiling, pWARN_STD);
d775746e
GS
2967 break;
2968 }
f4fc7782 2969 {
b5477537 2970 STRLEN len, i;
006c1a1d
Z
2971 int not_none = 0, not_all = 0;
2972 const U8 * const ptr = (const U8 *)SvPV_const(sv, len) ;
f4fc7782 2973 for (i = 0 ; i < len ; ++i) {
006c1a1d
Z
2974 not_none |= ptr[i];
2975 not_all |= ptr[i] ^ 0x55;
f4fc7782 2976 }
006c1a1d 2977 if (!not_none) {
1943af61 2978 free_and_set_cop_warnings(&PL_compiling, pWARN_NONE);
006c1a1d 2979 } else if (len >= WARNsize && !not_all) {
1943af61 2980 free_and_set_cop_warnings(&PL_compiling, pWARN_ALL);
94c8b9c1
N
2981 PL_dowarn |= G_WARN_ONCE ;
2982 }
2983 else {
2984 STRLEN len;
2985 const char *const p = SvPV_const(sv, len);
2986
2987 PL_compiling.cop_warnings
2988 = Perl_new_warnings_bitfield(aTHX_ PL_compiling.cop_warnings,
72dc9ed5
NC
2989 p, len);
2990
94c8b9c1 2991 if (isWARN_on(PL_compiling.cop_warnings, WARN_ONCE))
d3a7d8c7 2992 PL_dowarn |= G_WARN_ONCE ;
94c8b9c1 2993 }
f4fc7782 2994
d3a7d8c7 2995 }
4438c4b7 2996 }
971a9dd3 2997 }
8ca2a5d6
DD
2998#ifdef WIN32
2999 else if (strEQ(mg->mg_ptr+1, "IN32_SLOPPY_STAT")) {
3000 w32_sloppystat = (bool)sv_true(sv);
3001 }
3002#endif
79072805
LW
3003 break;
3004 case '.':
3280af22
NIS
3005 if (PL_localizing) {
3006 if (PL_localizing == 1)
7766f137 3007 SAVESPTR(PL_last_in_gv);
748a9306 3008 }
3280af22 3009 else if (SvOK(sv) && GvIO(PL_last_in_gv))
632db599 3010 IoLINES(GvIOp(PL_last_in_gv)) = SvIV(sv);
79072805
LW
3011 break;
3012 case '^':
acbe1b9d 3013 Safefree(IoTOP_NAME(GvIOp(PL_defoutgv)));
a9e2d2bf 3014 IoTOP_NAME(GvIOp(PL_defoutgv)) = savesvpv(sv);
acbe1b9d 3015 IoTOP_GV(GvIOp(PL_defoutgv)) = gv_fetchsv(sv, GV_ADD, SVt_PVIO);
79072805
LW
3016 break;
3017 case '~':
acbe1b9d 3018 Safefree(IoFMT_NAME(GvIOp(PL_defoutgv)));
a9e2d2bf 3019 IoFMT_NAME(GvIOp(PL_defoutgv)) = savesvpv(sv);
acbe1b9d 3020 IoFMT_GV(GvIOp(PL_defoutgv)) = gv_fetchsv(sv, GV_ADD, SVt_PVIO);
79072805
LW
3021 break;
3022 case '=':
acbe1b9d 3023 IoPAGE_LEN(GvIOp(PL_defoutgv)) = (SvIV(sv));
79072805
LW
3024 break;
3025 case '-':
acbe1b9d
FC
3026 IoLINES_LEFT(GvIOp(PL_defoutgv)) = (SvIV(sv));
3027 if (IoLINES_LEFT(GvIOp(PL_defoutgv)) < 0L)
099be4f1 3028 IoLINES_LEFT(GvIOp(PL_defoutgv)) = 0L;
79072805
LW
3029 break;
3030 case '%':
acbe1b9d 3031 IoPAGE(GvIOp(PL_defoutgv)) = (SvIV(sv));
79072805
LW
3032 break;
3033 case '|':
4b65379b 3034 {
099be4f1 3035 IO * const io = GvIO(PL_defoutgv);
720f287d
AB
3036 if(!io)
3037 break;
38ab35f8 3038 if ((SvIV(sv)) == 0)
4b65379b
CS
3039 IoFLAGS(io) &= ~IOf_FLUSH;
3040 else {
3041 if (!(IoFLAGS(io) & IOf_FLUSH)) {
3042 PerlIO *ofp = IoOFP(io);
3043 if (ofp)
3044 (void)PerlIO_flush(ofp);
3045 IoFLAGS(io) |= IOf_FLUSH;
3046 }
3047 }
79072805
LW
3048 }
3049 break;
79072805 3050 case '/':
1ab48e3a 3051 {
1ab48e3a 3052 if (SvROK(sv)) {
8d37cdf7
DIM
3053 SV *referent = SvRV(sv);
3054 const char *reftype = sv_reftype(referent, 0);
d239bea0
A
3055 /* XXX: dodgy type check: This leaves me feeling dirty, but
3056 * the alternative is to copy pretty much the entire
3057 * sv_reftype() into this routine, or to do a full string
3058 * comparison on the return of sv_reftype() both of which
3059 * make me feel worse! NOTE, do not modify this comment
3060 * without reviewing the corresponding comment in
3061 * sv_reftype(). - Yves */
1ab48e3a 3062 if (reftype[0] == 'S' || reftype[0] == 'L') {
8d37cdf7 3063 IV val = SvIV(referent);
1ab48e3a 3064 if (val <= 0) {
520b6fb6
DIM
3065 sv_setsv(sv, PL_rs);
3066 Perl_croak(aTHX_ "Setting $/ to a reference to %s is forbidden",
3067 val < 0 ? "a negative integer" : "zero");
1ab48e3a
YO
3068 }
3069 } else {
ddce084a 3070 sv_setsv(sv, PL_rs);
8d37cdf7 3071 /* diag_listed_as: Setting $/ to %s reference is forbidden */
a48e4205
FC
3072 Perl_croak(aTHX_ "Setting $/ to a%s %s reference is forbidden",
3073 *reftype == 'A' ? "n" : "", reftype);
1ab48e3a
YO
3074 }
3075 }
b3a2acfa 3076 SvREFCNT_dec(PL_rs);
520b6fb6 3077 PL_rs = newSVsv(sv);
b3a2acfa 3078 }
79072805
LW
3079 break;
3080 case '\\':
ef8d46e8 3081 SvREFCNT_dec(PL_ors_sv);
6bc2995b 3082 if (SvOK(sv)) {
7889fe52 3083 PL_ors_sv = newSVsv(sv);
009c130f 3084 }
e3c19b7b 3085 else {
a0714e2c 3086 PL_ors_sv = NULL;
e3c19b7b 3087 }
79072805 3088 break;
7d69d4a6
FC
3089 case '[':
3090 if (SvIV(sv) != 0)
3091 Perl_croak(aTHX_ "Assigning non-zero to $[ is no longer possible");
3092 break;
79072805 3093 case '?':
ff0cee69 3094#ifdef COMPLEX_STATUS
6b88bc9c 3095 if (PL_localizing == 2) {
41cb7b2b 3096 SvUPGRADE(sv, SVt_PVLV);
6b88bc9c
GS
3097 PL_statusvalue = LvTARGOFF(sv);
3098 PL_statusvalue_vms = LvTARGLEN(sv);
ff0cee69
PP
3099 }
3100 else
3101#endif
3102#ifdef VMSISH_STATUS
3103 if (VMSISH_STATUS)
fb38d079 3104 STATUS_NATIVE_CHILD_SET((U32)SvIV(sv));
ff0cee69
PP
3105 else
3106#endif
38ab35f8 3107 STATUS_UNIX_EXIT_SET(SvIV(sv));
79072805
LW
3108 break;
3109 case '!':
93189314
JH
3110 {
3111#ifdef VMS
3112# define PERL_VMS_BANG vaxc$errno
3113#else
3114# define PERL_VMS_BANG 0
3115#endif
79c32fc2 3116#if defined(WIN32)
c9beaf97
SH
3117 SETERRNO(win32_get_errno(SvIOK(sv) ? SvIVX(sv) : SvOK(sv) ? sv_2iv(sv) : 0),
3118 (SvIV(sv) == EVMSERR) ? 4 : PERL_VMS_BANG);
3119#else
91487cfc 3120 SETERRNO(SvIOK(sv) ? SvIVX(sv) : SvOK(sv) ? sv_2iv(sv) : 0,
93189314 3121 (SvIV(sv) == EVMSERR) ? 4 : PERL_VMS_BANG);
c9beaf97 3122#endif
93189314 3123 }
79072805
LW
3124 break;
3125 case '<':
985213f2 3126 {
b469f1e0 3127 /* XXX $< currently silently ignores failures */
dfff4baf 3128 const Uid_t new_uid = SvUID(sv);
985213f2 3129 PL_delaymagic_uid = new_uid;
3280af22
NIS
3130 if (PL_delaymagic) {
3131 PL_delaymagic |= DM_RUID;
79072805
LW
3132 break; /* don't do magic till later */
3133 }
3134#ifdef HAS_SETRUID
b469f1e0 3135 PERL_UNUSED_RESULT(setruid(new_uid));
2abc681d 3136#elif defined(HAS_SETREUID)
b469f1e0 3137 PERL_UNUSED_RESULT(setreuid(new_uid, (Uid_t)-1));
2abc681d 3138#elif defined(HAS_SETRESUID)
b469f1e0 3139 PERL_UNUSED_RESULT(setresuid(new_uid, (Uid_t)-1, (Uid_t)-1));
79072805 3140#else
985213f2 3141 if (new_uid == PerlProc_geteuid()) { /* special case $< = $> */
2abc681d 3142# ifdef PERL_DARWIN
75870ed3 3143 /* workaround for Darwin's setuid peculiarity, cf [perl #24122] */
985213f2 3144 if (new_uid != 0 && PerlProc_getuid() == 0)
b469f1e0 3145 PERL_UNUSED_RESULT(PerlProc_setuid(0));
2abc681d 3146# endif
b469f1e0 3147 PERL_UNUSED_RESULT(PerlProc_setuid(new_uid));
75870ed3 3148 } else {
cea2e8a9 3149 Perl_croak(aTHX_ "setruid() not implemented");
a0d0e21e 3150 }
79072805 3151#endif
79072805 3152 break;
985213f2 3153 }
79072805 3154 case '>':
985213f2 3155 {
b469f1e0 3156 /* XXX $> currently silently ignores failures */
dfff4baf 3157 const Uid_t new_euid = SvUID(sv);
985213f2 3158 PL_delaymagic_euid = new_euid;
3280af22
NIS
3159 if (PL_delaymagic) {
3160 PL_delaymagic |= DM_EUID;
79072805
LW
3161 break; /* don't do magic till later */
3162 }
3163#ifdef HAS_SETEUID
b469f1e0 3164 PERL_UNUSED_RESULT(seteuid(new_euid));
2abc681d 3165#elif defined(HAS_SETREUID)
b469f1e0 3166 PERL_UNUSED_RESULT(setreuid((Uid_t)-1, new_euid));
2abc681d 3167#elif defined(HAS_SETRESUID)
b469f1e0 3168 PERL_UNUSED_RESULT(setresuid((Uid_t)-1, new_euid, (Uid_t)-1));
79072805 3169#else
985213f2 3170 if (new_euid == PerlProc_getuid()) /* special case $> = $< */
b469f1e0 3171 PERL_UNUSED_RESULT(PerlProc_setuid(new_euid));
a0d0e21e 3172 else {
cea2e8a9 3173 Perl_croak(aTHX_ "seteuid() not implemented");
a0d0e21e 3174 }
79072805 3175#endif
79072805 3176 break;
985213f2 3177 }
79072805 3178 case '(':
985213f2 3179 {
b469f1e0 3180 /* XXX $( currently silently ignores failures */
dfff4baf 3181 const Gid_t new_gid = SvGID(sv);
985213f2 3182 PL_delaymagic_gid = new_gid;
3280af22
NIS
3183 if (PL_delaymagic) {
3184 PL_delaymagic |= DM_RGID;
79072805
LW
3185 break; /* don't do magic till later */
3186 }
3187#ifdef HAS_SETRGID
b469f1e0 3188 PERL_UNUSED_RESULT(setrgid(new_gid));
2abc681d 3189#elif defined(HAS_SETREGID)
b469f1e0 3190 PERL_UNUSED_RESULT(setregid(new_gid, (Gid_t)-1));
2abc681d 3191#elif defined(HAS_SETRESGID)
b469f1e0 3192 PERL_UNUSED_RESULT(setresgid(new_gid, (Gid_t)-1, (Gid_t) -1));
79072805 3193#else
985213f2 3194 if (new_gid == PerlProc_getegid()) /* special case $( = $) */
b469f1e0 3195 PERL_UNUSED_RESULT(PerlProc_setgid(new_gid));
748a9306 3196 else {
cea2e8a9 3197 Perl_croak(aTHX_ "setrgid() not implemented");
748a9306 3198 }
79072805 3199#endif
79072805 3200 break;
985213f2 3201 }
79072805 3202 case ')':
985213f2 3203 {
0635704a
HS
3204/* (hv) best guess: maybe we'll need configure probes to do a better job,
3205 * but you can override it if you need to.
3206 */
3207#ifndef INVALID_GID
3208#define INVALID_GID ((Gid_t)-1)
3209#endif
b469f1e0 3210 /* XXX $) currently silently ignores failures */
dfff4baf 3211 Gid_t new_egid;
5cd24f17
PP
3212#ifdef HAS_SETGROUPS
3213 {
b83604b4 3214 const char *p = SvPV_const(sv, len);
757f63d8 3215 Groups_t *gary = NULL;
79e302e6
MM
3216 const char* p_end = p + len;
3217 const char* endptr = p_end;
22ff3130 3218 UV uv;
fb4089e0 3219#ifdef _SC_NGROUPS_MAX
3220 int maxgrp = sysconf(_SC_NGROUPS_MAX);
3221
3222 if (maxgrp < 0)
3223 maxgrp = NGROUPS;
3224#else
3225 int maxgrp = NGROUPS;
3226#endif
757f63d8
SP
3227
3228 while (isSPACE(*p))
3229 ++p;
22ff3130
HS
3230 if (grok_atoUV(p, &uv, &endptr))
3231 new_egid = (Gid_t)uv;
3232 else {
0635704a 3233 new_egid = INVALID_GID;
22ff3130
HS
3234 endptr = NULL;
3235 }
fb4089e0 3236 for (i = 0; i < maxgrp; ++i) {
fdadaf77
JH
3237 if (endptr == NULL)
3238 break;
3239 p = endptr;
79e302e6 3240 endptr = p_end;
757f63d8
SP
3241 while (isSPACE(*p))
3242 ++p;
3243 if (!*p)
3244 break;
fdadaf77 3245 if (!gary)
757f63d8
SP
3246 Newx(gary, i + 1, Groups_t);
3247 else
3248 Renew(gary, i + 1, Groups_t);
22ff3130
HS
3249 if (grok_atoUV(p, &uv, &endptr))
3250 gary[i] = (Groups_t)uv;
3251 else {
0635704a 3252 gary[i] = INVALID_GID;
22ff3130
HS
3253 endptr = NULL;
3254 }
757f63d8
SP
3255 }
3256 if (i)
b469f1e0 3257 PERL_UNUSED_RESULT(setgroups(i, gary));
f5a63d97 3258 Safefree(gary);
5cd24f17
PP
3259 }
3260#else /* HAS_SETGROUPS */
dfff4baf 3261 new_egid = SvGID(sv);
5cd24f17 3262#endif /* HAS_SETGROUPS */
985213f2 3263 PL_delaymagic_egid = new_egid;
3280af22
NIS
3264 if (PL_delaymagic) {
3265 PL_delaymagic |= DM_EGID;
79072805
LW
3266 break; /* don't do magic till later */
3267 }
3268#ifdef HAS_SETEGID
b469f1e0 3269 PERL_UNUSED_RESULT(setegid(new_egid));
2abc681d 3270#elif defined(HAS_SETREGID)
b469f1e0 3271 PERL_UNUSED_RESULT(setregid((Gid_t)-1, new_egid));
2abc681d 3272#elif defined(HAS_SETRESGID)
b469f1e0 3273 PERL_UNUSED_RESULT(setresgid((Gid_t)-1, new_egid, (Gid_t)-1));
79072805 3274#else
985213f2 3275 if (new_egid == PerlProc_getgid()) /* special case $) = $( */
b469f1e0 3276 PERL_UNUSED_RESULT(PerlProc_setgid(new_egid));
748a9306 3277 else {
cea2e8a9 3278 Perl_croak(aTHX_ "setegid() not implemented");
748a9306 3279 }
79072805 3280#endif
79072805 3281 break;
985213f2 3282 }
79072805 3283 case ':':
2d8e6c8d 3284 PL_chopset = SvPV_force(sv,len);
79072805 3285 break;
9cdac2a2
FC
3286 case '$': /* $$ */
3287 /* Store the pid in mg->mg_obj so we can tell when a fork has
3288 occurred. mg->mg_obj points to *$ by default, so clear it. */
3289 if (isGV(mg->mg_obj)) {
3290 if (mg->mg_flags & MGf_REFCOUNTED) /* probably never true */
3291 SvREFCNT_dec(mg->mg_obj);
3292 mg->mg_flags |= MGf_REFCOUNTED;
3293 mg->mg_obj = newSViv((IV)PerlProc_getpid());
3294 }
3295 else sv_setiv(mg->mg_obj, (IV)PerlProc_getpid());
3296 break;
79072805 3297 case '0':
e2975953 3298 LOCK_DOLLARZERO_MUTEX;
f1540bed 3299 S_set_dollarzero(aTHX_ sv);
e2975953 3300 UNLOCK_DOLLARZERO_MUTEX;
79072805
LW
3301 break;
3302 }
3303 return 0;
3304}
3305
3306I32
84c7b88c
BF
3307Perl_whichsig_sv(pTHX_ SV *sigsv)
3308{
3309 const char *sigpv;
3310 STRLEN siglen;
3311 PERL_ARGS_ASSERT_WHICHSIG_SV;
84c7b88c
BF
3312 sigpv = SvPV_const(sigsv, siglen);
3313 return whichsig_pvn(sigpv, siglen);
3314}
3315
3316I32
3317Perl_whichsig_pv(pTHX_ const char *sig)
3318{
3319 PERL_ARGS_ASSERT_WHICHSIG_PV;
84c7b88c
BF
3320 return whichsig_pvn(sig, strlen(sig));
3321}
3322
3323I32
3324Perl_whichsig_pvn(pTHX_ const char *sig, STRLEN len)
79072805 3325{
eb578fdb 3326 char* const* sigv;
7918f24d 3327
84c7b88c 3328 PERL_ARGS_ASSERT_WHICHSIG_PVN;
96a5add6 3329 PERL_UNUSED_CONTEXT;
79072805 3330
aadb217d 3331 for (sigv = (char* const*)PL_sig_name; *sigv; sigv++)
84c7b88c 3332 if (strlen(*sigv) == len && memEQ(sig,*sigv, len))
aadb217d 3333 return PL_sig_num[sigv - (char* const*)PL_sig_name];
79072805 3334#ifdef SIGCLD
84c7b88c 3335 if (memEQs(sig, len, "CHLD"))
79072805
LW
3336 return SIGCLD;
3337#endif
3338#ifdef SIGCHLD
84c7b88c 3339 if (memEQs(sig, len, "CLD"))
79072805
LW
3340 return SIGCHLD;
3341#endif
7f1236c0 3342 return -1;
79072805
LW
3343}
3344
dc37125b
DM
3345
3346/* Perl_sighandler(), Perl_sighandler1(), Perl_sighandler3():
3347 * these three function are intended to be called by the OS as 'C' level
3348 * signal handler functions in the case where unsafe signals are being
3349 * used - i.e. they immediately invoke Perl_perly_sighandler() to call the
3350 * perl-level sighandler, rather than deferring.
3351 * In fact, the core itself will normally use Perl_csighandler as the
3352 * OS-level handler; that function will then decide whether to queue the
3353 * signal or call Perl_sighandler / Perl_perly_sighandler itself. So these
3354 * functions are more useful for e.g. POSIX.xs when it wants explicit
3355 * control of what's happening.
3356 */
3357
3358
5e7940ce 3359#ifdef PERL_USE_3ARG_SIGHANDLER
8a5e470b
DM
3360
3361Signal_t
e7124897 3362Perl_sighandler(int sig, Siginfo_t *sip, void *uap)
8a5e470b
DM
3363{
3364 Perl_perly_sighandler(sig, sip, uap, 0);
3365}
3366
1e82f5a6 3367#else
8a5e470b
DM
3368
3369Signal_t
1e82f5a6 3370Perl_sighandler(int sig)
8a5e470b
DM
3371{
3372 Perl_perly_sighandler(sig, NULL, NULL, 0);
3373}
3374
1e82f5a6 3375#endif
8a5e470b 3376
dc37125b
DM
3377Signal_t
3378Perl_sighandler1(int sig)
3379{
3380 Perl_perly_sighandler(sig, NULL, NULL, 0);
3381}
3382
3383Signal_t
3384Perl_sighandler3(int sig, Siginfo_t *sip PERL_UNUSED_DECL, void *uap PERL_UNUSED_DECL)
3385{
3386 Perl_perly_sighandler(sig, sip, uap, 0);
3387}
3388
3389
8a5e470b
DM
3390/* Invoke the perl-level signal handler. This function is called either
3391 * directly from one of the C-level signals handlers (Perl_sighandler or
3392 * Perl_csighandler), or for safe signals, later from
3393 * Perl_despatch_signals() at a suitable safe point during execution.
3394 *
3395 * 'safe' is a boolean indicating the latter call path.
3396 */
3397
3398Signal_t
3399Perl_perly_sighandler(int sig, Siginfo_t *sip PERL_UNUSED_DECL,
3400 void *uap PERL_UNUSED_DECL, bool safe)
79072805 3401{
1018e26f
NIS
3402#ifdef PERL_GET_SIG_CONTEXT
3403 dTHXa(PERL_GET_SIG_CONTEXT);
71d280e3 3404#else
cea2e8a9 3405 dTHX;
71d280e3 3406#endif
79072805 3407 dSP;
a0714e2c
SS
3408 GV *gv = NULL;
3409 SV *sv = NULL;
8772537c 3410 SV * const tSv = PL_Sv;
601f1833 3411 CV *cv = NULL;
533c011a 3412 OP *myop = PL_op;
84902520 3413 U32 flags = 0;
8772537c 3414 XPV * const tXpv = PL_Xpv;
0c4d3b5e 3415 I32 old_ss_ix = PL_savestack_ix;
100c03aa 3416 SV *errsv_save = NULL;
71d280e3 3417
84902520 3418
727405f8 3419 if (!PL_psig_ptr[sig]) {
99ef548b 3420 PerlIO_printf(Perl_error_log, "Signal SIG%s received, but no signal handler set.\n",
727405f8
NIS
3421 PL_sig_name[sig]);
3422 exit(sig);
3423 }
ff0cee69 3424
a0d63a7b
DM
3425 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG) {
3426 /* Max number of items pushed there is 3*n or 4. We cannot fix
3427 infinity, so we fix 4 (in fact 5): */
3428 if (PL_savestack_ix + 15 <= PL_savestack_max) {
3429 flags |= 1;
3430 PL_savestack_ix += 5; /* Protect save in progress. */
3431 SAVEDESTRUCTOR_X(S_unwind_handler_stack, NULL);
3432 }
84902520 3433 }
84902520 3434 /* sv_2cv is too complicated, try a simpler variant first: */
ea726b52 3435 if (!SvROK(PL_psig_ptr[sig]) || !(cv = MUTABLE_CV(SvRV(PL_psig_ptr[sig])))
8772537c
AL
3436 || SvTYPE(cv) != SVt_PVCV) {
3437 HV *st;
f2c0649b 3438 cv = sv_2cv(PL_psig_ptr[sig], &st, &gv, GV_ADD);
8772537c 3439 }
84902520 3440
a0d0e21e 3441 if (!cv || !CvROOT(cv)) {
07c325bb 3442 const HEK * const hek = gv
1d6bb9ae
FC
3443 ? GvENAME_HEK(gv)
3444 : cv && CvNAMED(cv)
3445 ? CvNAME_HEK(cv)
07c325bb
FC
3446 : cv && CvGV(cv) ? GvENAME_HEK(CvGV(cv)) : NULL;
3447 if (hek)
3448 Perl_ck_warner(aTHX_ packWARN(WARN_SIGNAL),
147e3846 3449 "SIG%s handler \"%" HEKf "\" not defined.\n",
ac892e4a 3450 PL_sig_name[sig], HEKfARG(hek));
07c325bb
FC
3451 /* diag_listed_as: SIG%s handler "%s" not defined */
3452 else Perl_ck_warner(aTHX_ packWARN(WARN_SIGNAL),
3453 "SIG%s handler \"__ANON__\" not defined.\n",
3454 PL_sig_name[sig]);
00d579c5 3455 goto cleanup;
79072805
LW
3456 }
3457
0c4d3b5e
DM
3458 sv = PL_psig_name[sig]
3459 ? SvREFCNT_inc_NN(PL_psig_name[sig])
3460 : newSVpv(PL_sig_name[sig],0);
72048cfe 3461 flags |= 8;
0c4d3b5e
DM
3462 SAVEFREESV(sv);
3463
a0d63a7b
DM
3464 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG) {
3465 /* make sure our assumption about the size of the SAVEs are correct:
3466 * 3 for SAVEDESTRUCTOR_X, 2 for SAVEFREESV */
3467 assert(old_ss_ix + 2 + ((flags & 1) ? 3+5 : 0) == PL_savestack_ix);
3468 }
e336de0d 3469
e788e7d3 3470 PUSHSTACKi(PERLSI_SIGNAL);
924508f0 3471 PUSHMARK(SP);
79072805 3472 PUSHs(sv);
dc43527e 3473
8aad04aa
JH
3474#if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
3475 {