mg.c

   1 /*    mg.c
   2  *
   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
   5  *
   6  *    You may distribute under the terms of either the GNU General Public
   7  *    License or the Artistic License, as specified in the README file.
   8  *
   9  */
  10
  11 /*
  12  *  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"]
  16  */
  17
  18 /*
  19 =head1 Magical Functions
  20
  21 "Magic" is special data attached to SV structures in order to give them
  22 "magical" properties.  When any Perl code tries to read from, or assign to,
  23 an SV marked as magical, it calls the 'get' or 'set' function associated
  24 with that SV's magic. A get is called prior to reading an SV, in order to
  25 give it a chance to update its internal value (get on $. writes the line
  26 number of the last read filehandle into to the SV's IV slot), while
  27 set is called after an SV has been written to, in order to allow it to make
  28 use of its changed value (set on $/ copies the SV's new value to the
  29 PL_rs global variable).
  30
  31 Magic is implemented as a linked list of MAGIC structures attached to the
  32 SV. Each MAGIC struct holds the type of the magic, a pointer to an array
  33 of functions that implement the get(), set(), length() etc functions,
  34 plus space for some flags and pointers. For example, a tied variable has
  35 a MAGIC structure that contains a pointer to the object associated with the
  36 tie.
  37
  38 */
  39
  40 #include "EXTERN.h"
  41 #define PERL_IN_MG_C
  42 #include "perl.h"
  43
  44 #if defined(HAS_GETGROUPS) || defined(HAS_SETGROUPS)
  45 #  ifdef I_GRP
  46 #    include <grp.h>
  47 #  endif
  48 #endif
  49
  50 #if defined(HAS_SETGROUPS)
  51 #  ifndef NGROUPS
  52 #    define NGROUPS 32
  53 #  endif
  54 #endif
  55
  56 #ifdef __hpux
  57 #  include <sys/pstat.h>
  58 #endif
  59
  60 #ifdef HAS_PRCTL_SET_NAME
  61 #  include <sys/prctl.h>
  62 #endif
  63
  64 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
  65 Signal_t Perl_csighandler(int sig, siginfo_t *, void *);
  66 #else
  67 Signal_t Perl_csighandler(int sig);
  68 #endif
  69
  70 #ifdef __Lynx__
  71 /* Missing protos on LynxOS */
  72 void setruid(uid_t id);
  73 void seteuid(uid_t id);
  74 void setrgid(uid_t id);
  75 void setegid(uid_t id);
  76 #endif
  77
  78 /*
  79  * Use the "DESTRUCTOR" scope cleanup to reinstate magic.
  80  */
  81
  82 struct magic_state {
  83     SV* mgs_sv;
  84     I32 mgs_ss_ix;
  85     U32 mgs_magical;
  86     bool mgs_readonly;
  87 };
  88 /* MGS is typedef'ed to struct magic_state in perl.h */
  89
  90 STATIC void
  91 S_save_magic(pTHX_ I32 mgs_ix, SV *sv)
  92 {
  93     dVAR;
  94     MGS* mgs;
  95
  96     PERL_ARGS_ASSERT_SAVE_MAGIC;
  97
  98     /* guard against sv having being freed midway by holding a private
  99        reference. */
 100     SvREFCNT_inc_simple_void_NN(sv);
 101
 102     assert(SvMAGICAL(sv));
 103     /* Turning READONLY off for a copy-on-write scalar (including shared
 104        hash keys) is a bad idea.  */
 105     if (SvIsCOW(sv))
 106       sv_force_normal_flags(sv, 0);
 107
 108     SAVEDESTRUCTOR_X(S_restore_magic, INT2PTR(void*, (IV)mgs_ix));
 109
 110     mgs = SSPTR(mgs_ix, MGS*);
 111     mgs->mgs_sv = sv;
 112     mgs->mgs_magical = SvMAGICAL(sv);
 113     mgs->mgs_readonly = SvREADONLY(sv) != 0;
 114     mgs->mgs_ss_ix = PL_savestack_ix;   /* points after the saved destructor */
 115
 116     SvMAGICAL_off(sv);
 117     SvREADONLY_off(sv);
 118     if (!(SvFLAGS(sv) & (SVf_IOK|SVf_NOK|SVf_POK))) {
 119         /* No public flags are set, so promote any private flags to public.  */
 120         SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
 121     }
 122 }
 123
 124 /*
 125 =for apidoc mg_magical
 126
 127 Turns on the magical status of an SV.  See C<sv_magic>.
 128
 129 =cut
 130 */
 131
 132 void
 133 Perl_mg_magical(pTHX_ SV *sv)
 134 {
 135     const MAGIC* mg;
 136     PERL_ARGS_ASSERT_MG_MAGICAL;
 137     PERL_UNUSED_CONTEXT;
 138
 139     SvMAGICAL_off(sv);
 140     if ((mg = SvMAGIC(sv))) {
 141         do {
 142             const MGVTBL* const vtbl = mg->mg_virtual;
 143             if (vtbl) {
 144                 if (vtbl->svt_get && !(mg->mg_flags & MGf_GSKIP))
 145                     SvGMAGICAL_on(sv);
 146                 if (vtbl->svt_set)
 147                     SvSMAGICAL_on(sv);
 148                 if (vtbl->svt_clear)
 149                     SvRMAGICAL_on(sv);
 150             }
 151         } while ((mg = mg->mg_moremagic));
 152         if (!(SvFLAGS(sv) & (SVs_GMG|SVs_SMG)))
 153             SvRMAGICAL_on(sv);
 154     }
 155 }
 156
 157
 158 /* is this container magic (%ENV, $1 etc), or value magic (pos, taint etc)? */
 159
 160 STATIC bool
 161 S_is_container_magic(const MAGIC *mg)
 162 {
 163     assert(mg);
 164     switch (mg->mg_type) {
 165     case PERL_MAGIC_bm:
 166     case PERL_MAGIC_fm:
 167     case PERL_MAGIC_regex_global:
 168     case PERL_MAGIC_nkeys:
 169 #ifdef USE_LOCALE_COLLATE
 170     case PERL_MAGIC_collxfrm:
 171 #endif
 172     case PERL_MAGIC_qr:
 173     case PERL_MAGIC_taint:
 174     case PERL_MAGIC_vec:
 175     case PERL_MAGIC_vstring:
 176     case PERL_MAGIC_utf8:
 177     case PERL_MAGIC_substr:
 178     case PERL_MAGIC_defelem:
 179     case PERL_MAGIC_arylen:
 180     case PERL_MAGIC_pos:
 181     case PERL_MAGIC_backref:
 182     case PERL_MAGIC_arylen_p:
 183     case PERL_MAGIC_rhash:
 184     case PERL_MAGIC_symtab:
 185     case PERL_MAGIC_tied: /* treat as value, so 'local @tied' isn't tied */
 186     case PERL_MAGIC_checkcall:
 187         return 0;
 188     default:
 189         return 1;
 190     }
 191 }
 192
 193 /*
 194 =for apidoc mg_get
 195
 196 Do magic after a value is retrieved from the SV.  See C<sv_magic>.
 197
 198 =cut
 199 */
 200
 201 int
 202 Perl_mg_get(pTHX_ SV *sv)
 203 {
 204     dVAR;
 205     const I32 mgs_ix = SSNEW(sizeof(MGS));
 206     bool have_new = 0;
 207     MAGIC *newmg, *head, *cur, *mg;
 208
 209     PERL_ARGS_ASSERT_MG_GET;
 210
 211     save_magic(mgs_ix, sv);
 212
 213     /* We must call svt_get(sv, mg) for each valid entry in the linked
 214        list of magic. svt_get() may delete the current entry, add new
 215        magic to the head of the list, or upgrade the SV. AMS 20010810 */
 216
 217     newmg = cur = head = mg = SvMAGIC(sv);
 218     while (mg) {
 219         const MGVTBL * const vtbl = mg->mg_virtual;
 220         MAGIC * const nextmg = mg->mg_moremagic;        /* it may delete itself */
 221
 222         if (!(mg->mg_flags & MGf_GSKIP) && vtbl && vtbl->svt_get) {
 223             vtbl->svt_get(aTHX_ sv, mg);
 224
 225             /* guard against magic having been deleted - eg FETCH calling
 226              * untie */
 227             if (!SvMAGIC(sv)) {
 228                 (SSPTR(mgs_ix, MGS *))->mgs_magical = 0; /* recalculate flags */
 229                 break;
 230             }
 231
 232             /* recalculate flags if this entry was deleted. */
 233             if (mg->mg_flags & MGf_GSKIP)
 234                 (SSPTR(mgs_ix, MGS *))->mgs_magical = 0;
 235         }
 236
 237         mg = nextmg;
 238
 239         if (have_new) {
 240             /* Have we finished with the new entries we saw? Start again
 241                where we left off (unless there are more new entries). */
 242             if (mg == head) {
 243                 have_new = 0;
 244                 mg   = cur;
 245                 head = newmg;
 246             }
 247         }
 248
 249         /* Were any new entries added? */
 250         if (!have_new && (newmg = SvMAGIC(sv)) != head) {
 251             have_new = 1;
 252             cur = mg;
 253             mg  = newmg;
 254             (SSPTR(mgs_ix, MGS *))->mgs_magical = 0; /* recalculate flags */
 255         }
 256     }
 257
 258     restore_magic(INT2PTR(void *, (IV)mgs_ix));
 259     return 0;
 260 }
 261
 262 /*
 263 =for apidoc mg_set
 264
 265 Do magic after a value is assigned to the SV.  See C<sv_magic>.
 266
 267 =cut
 268 */
 269
 270 int
 271 Perl_mg_set(pTHX_ SV *sv)
 272 {
 273     dVAR;
 274     const I32 mgs_ix = SSNEW(sizeof(MGS));
 275     MAGIC* mg;
 276     MAGIC* nextmg;
 277
 278     PERL_ARGS_ASSERT_MG_SET;
 279
 280     save_magic(mgs_ix, sv);
 281
 282     for (mg = SvMAGIC(sv); mg; mg = nextmg) {
 283         const MGVTBL* vtbl = mg->mg_virtual;
 284         nextmg = mg->mg_moremagic;      /* it may delete itself */
 285         if (mg->mg_flags & MGf_GSKIP) {
 286             mg->mg_flags &= ~MGf_GSKIP; /* setting requires another read */
 287             (SSPTR(mgs_ix, MGS*))->mgs_magical = 0;
 288         }
 289         if (PL_localizing == 2 && !S_is_container_magic(mg))
 290             continue;
 291         if (vtbl && vtbl->svt_set)
 292             vtbl->svt_set(aTHX_ sv, mg);
 293     }
 294
 295     restore_magic(INT2PTR(void*, (IV)mgs_ix));
 296     return 0;
 297 }
 298
 299 /*
 300 =for apidoc mg_length
 301
 302 Report on the SV's length.  See C<sv_magic>.
 303
 304 =cut
 305 */
 306
 307 U32
 308 Perl_mg_length(pTHX_ SV *sv)
 309 {
 310     dVAR;
 311     MAGIC* mg;
 312     STRLEN len;
 313
 314     PERL_ARGS_ASSERT_MG_LENGTH;
 315
 316     for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
 317         const MGVTBL * const vtbl = mg->mg_virtual;
 318         if (vtbl && vtbl->svt_len) {
 319             const I32 mgs_ix = SSNEW(sizeof(MGS));
 320             save_magic(mgs_ix, sv);
 321             /* omit MGf_GSKIP -- not changed here */
 322             len = vtbl->svt_len(aTHX_ sv, mg);
 323             restore_magic(INT2PTR(void*, (IV)mgs_ix));
 324             return len;
 325         }
 326     }
 327
 328     {
 329         /* You can't know whether it's UTF-8 until you get the string again...
 330          */
 331         const U8 *s = (U8*)SvPV_const(sv, len);
 332
 333         if (DO_UTF8(sv)) {
 334             len = utf8_length(s, s + len);
 335         }
 336     }
 337     return len;
 338 }
 339
 340 I32
 341 Perl_mg_size(pTHX_ SV *sv)
 342 {
 343     MAGIC* mg;
 344
 345     PERL_ARGS_ASSERT_MG_SIZE;
 346
 347     for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
 348         const MGVTBL* const vtbl = mg->mg_virtual;
 349         if (vtbl && vtbl->svt_len) {
 350             const I32 mgs_ix = SSNEW(sizeof(MGS));
 351             I32 len;
 352             save_magic(mgs_ix, sv);
 353             /* omit MGf_GSKIP -- not changed here */
 354             len = vtbl->svt_len(aTHX_ sv, mg);
 355             restore_magic(INT2PTR(void*, (IV)mgs_ix));
 356             return len;
 357         }
 358     }
 359
 360     switch(SvTYPE(sv)) {
 361         case SVt_PVAV:
 362             return AvFILLp((const AV *) sv); /* Fallback to non-tied array */
 363         case SVt_PVHV:
 364             /* FIXME */
 365         default:
 366             Perl_croak(aTHX_ "Size magic not implemented");
 367             break;
 368     }
 369     return 0;
 370 }
 371
 372 /*
 373 =for apidoc mg_clear
 374
 375 Clear something magical that the SV represents.  See C<sv_magic>.
 376
 377 =cut
 378 */
 379
 380 int
 381 Perl_mg_clear(pTHX_ SV *sv)
 382 {
 383     const I32 mgs_ix = SSNEW(sizeof(MGS));
 384     MAGIC* mg;
 385     MAGIC *nextmg;
 386
 387     PERL_ARGS_ASSERT_MG_CLEAR;
 388
 389     save_magic(mgs_ix, sv);
 390
 391     for (mg = SvMAGIC(sv); mg; mg = nextmg) {
 392         const MGVTBL* const vtbl = mg->mg_virtual;
 393         /* omit GSKIP -- never set here */
 394
 395         nextmg = mg->mg_moremagic; /* it may delete itself */
 396
 397         if (vtbl && vtbl->svt_clear)
 398             vtbl->svt_clear(aTHX_ sv, mg);
 399     }
 400
 401     restore_magic(INT2PTR(void*, (IV)mgs_ix));
 402     return 0;
 403 }
 404
 405 MAGIC*
 406 S_mg_findext_flags(pTHX_ const SV *sv, int type, const MGVTBL *vtbl, U32 flags)
 407 {
 408     PERL_UNUSED_CONTEXT;
 409
 410     assert(flags <= 1);
 411
 412     if (sv) {
 413         MAGIC *mg;
 414
 415         for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
 416             if (mg->mg_type == type && (!flags || mg->mg_virtual == vtbl)) {
 417                 return mg;
 418             }
 419         }
 420     }
 421
 422     return NULL;
 423 }
 424
 425 /*
 426 =for apidoc mg_find
 427
 428 Finds the magic pointer for type matching the SV.  See C<sv_magic>.
 429
 430 =cut
 431 */
 432
 433 MAGIC*
 434 Perl_mg_find(pTHX_ const SV *sv, int type)
 435 {
 436     return S_mg_findext_flags(aTHX_ sv, type, NULL, 0);
 437 }
 438
 439 /*
 440 =for apidoc mg_findext
 441
 442 Finds the magic pointer of C<type> with the given C<vtbl> for the C<SV>.  See
 443 C<sv_magicext>.
 444
 445 =cut
 446 */
 447
 448 MAGIC*
 449 Perl_mg_findext(pTHX_ const SV *sv, int type, const MGVTBL *vtbl)
 450 {
 451     return S_mg_findext_flags(aTHX_ sv, type, vtbl, 1);
 452 }
 453
 454 /*
 455 =for apidoc mg_copy
 456
 457 Copies the magic from one SV to another.  See C<sv_magic>.
 458
 459 =cut
 460 */
 461
 462 int
 463 Perl_mg_copy(pTHX_ SV *sv, SV *nsv, const char *key, I32 klen)
 464 {
 465     int count = 0;
 466     MAGIC* mg;
 467
 468     PERL_ARGS_ASSERT_MG_COPY;
 469
 470     for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
 471         const MGVTBL* const vtbl = mg->mg_virtual;
 472         if ((mg->mg_flags & MGf_COPY) && vtbl->svt_copy){
 473             count += vtbl->svt_copy(aTHX_ sv, mg, nsv, key, klen);
 474         }
 475         else {
 476             const char type = mg->mg_type;
 477             if (isUPPER(type) && type != PERL_MAGIC_uvar) {
 478                 sv_magic(nsv,
 479                      (type == PERL_MAGIC_tied)
 480                         ? SvTIED_obj(sv, mg)
 481                         : (type == PERL_MAGIC_regdata && mg->mg_obj)
 482                             ? sv
 483                             : mg->mg_obj,
 484                      toLOWER(type), key, klen);
 485                 count++;
 486             }
 487         }
 488     }
 489     return count;
 490 }
 491
 492 /*
 493 =for apidoc mg_localize
 494
 495 Copy some of the magic from an existing SV to new localized version of that
 496 SV. Container magic (eg %ENV, $1, tie) gets copied, value magic doesn't (eg
 497 taint, pos).
 498
 499 If setmagic is false then no set magic will be called on the new (empty) SV.
 500 This typically means that assignment will soon follow (e.g. 'local $x = $y'),
 501 and that will handle the magic.
 502
 503 =cut
 504 */
 505
 506 void
 507 Perl_mg_localize(pTHX_ SV *sv, SV *nsv, bool setmagic)
 508 {
 509     dVAR;
 510     MAGIC *mg;
 511
 512     PERL_ARGS_ASSERT_MG_LOCALIZE;
 513
 514     for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
 515         const MGVTBL* const vtbl = mg->mg_virtual;
 516         if (!S_is_container_magic(mg))
 517             continue;
 518
 519         if ((mg->mg_flags & MGf_LOCAL) && vtbl->svt_local)
 520             (void)vtbl->svt_local(aTHX_ nsv, mg);
 521         else
 522             sv_magicext(nsv, mg->mg_obj, mg->mg_type, vtbl,
 523                             mg->mg_ptr, mg->mg_len);
 524
 525         /* container types should remain read-only across localization */
 526         SvFLAGS(nsv) |= SvREADONLY(sv);
 527     }
 528
 529     if (SvTYPE(nsv) >= SVt_PVMG && SvMAGIC(nsv)) {
 530         SvFLAGS(nsv) |= SvMAGICAL(sv);
 531         if (setmagic) {
 532             PL_localizing = 1;
 533             SvSETMAGIC(nsv);
 534             PL_localizing = 0;
 535         }
 536     }
 537 }
 538
 539 #define mg_free_struct(sv, mg) S_mg_free_struct(aTHX_ sv, mg)
 540 static void
 541 S_mg_free_struct(pTHX_ SV *sv, MAGIC *mg)
 542 {
 543     const MGVTBL* const vtbl = mg->mg_virtual;
 544     if (vtbl && vtbl->svt_free)
 545         vtbl->svt_free(aTHX_ sv, mg);
 546     if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
 547         if (mg->mg_len > 0 || mg->mg_type == PERL_MAGIC_utf8)
 548             Safefree(mg->mg_ptr);
 549         else if (mg->mg_len == HEf_SVKEY)
 550             SvREFCNT_dec(MUTABLE_SV(mg->mg_ptr));
 551     }
 552     if (mg->mg_flags & MGf_REFCOUNTED)
 553         SvREFCNT_dec(mg->mg_obj);
 554     Safefree(mg);
 555 }
 556
 557 /*
 558 =for apidoc mg_free
 559
 560 Free any magic storage used by the SV.  See C<sv_magic>.
 561
 562 =cut
 563 */
 564
 565 int
 566 Perl_mg_free(pTHX_ SV *sv)
 567 {
 568     MAGIC* mg;
 569     MAGIC* moremagic;
 570
 571     PERL_ARGS_ASSERT_MG_FREE;
 572
 573     for (mg = SvMAGIC(sv); mg; mg = moremagic) {
 574         moremagic = mg->mg_moremagic;
 575         mg_free_struct(sv, mg);
 576         SvMAGIC_set(sv, moremagic);
 577     }
 578     SvMAGIC_set(sv, NULL);
 579     SvMAGICAL_off(sv);
 580     return 0;
 581 }
 582
 583 /*
 584 =for apidoc Am|void|mg_free_type|SV *sv|int how
 585
 586 Remove any magic of type I<how> from the SV I<sv>.  See L</sv_magic>.
 587
 588 =cut
 589 */
 590
 591 void
 592 Perl_mg_free_type(pTHX_ SV *sv, int how)
 593 {
 594     MAGIC *mg, *prevmg, *moremg;
 595     PERL_ARGS_ASSERT_MG_FREE_TYPE;
 596     for (prevmg = NULL, mg = SvMAGIC(sv); mg; prevmg = mg, mg = moremg) {
 597         MAGIC *newhead;
 598         moremg = mg->mg_moremagic;
 599         if (mg->mg_type == how) {
 600             /* temporarily move to the head of the magic chain, in case
 601                custom free code relies on this historical aspect of mg_free */
 602             if (prevmg) {
 603                 prevmg->mg_moremagic = moremg;
 604                 mg->mg_moremagic = SvMAGIC(sv);
 605                 SvMAGIC_set(sv, mg);
 606             }
 607             newhead = mg->mg_moremagic;
 608             mg_free_struct(sv, mg);
 609             SvMAGIC_set(sv, newhead);
 610             mg = prevmg;
 611         }
 612     }
 613     mg_magical(sv);
 614 }
 615
 616 #include <signal.h>
 617
 618 U32
 619 Perl_magic_regdata_cnt(pTHX_ SV *sv, MAGIC *mg)
 620 {
 621     dVAR;
 622     PERL_UNUSED_ARG(sv);
 623
 624     PERL_ARGS_ASSERT_MAGIC_REGDATA_CNT;
 625
 626     if (PL_curpm) {
 627         register const REGEXP * const rx = PM_GETRE(PL_curpm);
 628         if (rx) {
 629             if (mg->mg_obj) {                   /* @+ */
 630                 /* return the number possible */
 631                 return RX_NPARENS(rx);
 632             } else {                            /* @- */
 633                 I32 paren = RX_LASTPAREN(rx);
 634
 635                 /* return the last filled */
 636                 while ( paren >= 0
 637                         && (RX_OFFS(rx)[paren].start == -1
 638                             || RX_OFFS(rx)[paren].end == -1) )
 639                     paren--;
 640                 return (U32)paren;
 641             }
 642         }
 643     }
 644
 645     return (U32)-1;
 646 }
 647
 648 int
 649 Perl_magic_regdatum_get(pTHX_ SV *sv, MAGIC *mg)
 650 {
 651     dVAR;
 652
 653     PERL_ARGS_ASSERT_MAGIC_REGDATUM_GET;
 654
 655     if (PL_curpm) {
 656         register const REGEXP * const rx = PM_GETRE(PL_curpm);
 657         if (rx) {
 658             register const I32 paren = mg->mg_len;
 659             register I32 s;
 660             register I32 t;
 661             if (paren < 0)
 662                 return 0;
 663             if (paren <= (I32)RX_NPARENS(rx) &&
 664                 (s = RX_OFFS(rx)[paren].start) != -1 &&
 665                 (t = RX_OFFS(rx)[paren].end) != -1)
 666                 {
 667                     register I32 i;
 668                     if (mg->mg_obj)             /* @+ */
 669                         i = t;
 670                     else                        /* @- */
 671                         i = s;
 672
 673                     if (i > 0 && RX_MATCH_UTF8(rx)) {
 674                         const char * const b = RX_SUBBEG(rx);
 675                         if (b)
 676                             i = utf8_length((U8*)b, (U8*)(b+i));
 677                     }
 678
 679                     sv_setiv(sv, i);
 680                 }
 681         }
 682     }
 683     return 0;
 684 }
 685
 686 int
 687 Perl_magic_regdatum_set(pTHX_ SV *sv, MAGIC *mg)
 688 {
 689     PERL_ARGS_ASSERT_MAGIC_REGDATUM_SET;
 690     PERL_UNUSED_ARG(sv);
 691     PERL_UNUSED_ARG(mg);
 692     Perl_croak_no_modify(aTHX);
 693     NORETURN_FUNCTION_END;
 694 }
 695
 696 U32
 697 Perl_magic_len(pTHX_ SV *sv, MAGIC *mg)
 698 {
 699     dVAR;
 700     register I32 paren;
 701     register I32 i;
 702     register const REGEXP * rx;
 703     const char * const remaining = mg->mg_ptr + 1;
 704
 705     PERL_ARGS_ASSERT_MAGIC_LEN;
 706
 707     switch (*mg->mg_ptr) {
 708     case '\020':
 709       if (*remaining == '\0') { /* ^P */
 710           break;
 711       } else if (strEQ(remaining, "REMATCH")) { /* $^PREMATCH */
 712           goto do_prematch;
 713       } else if (strEQ(remaining, "OSTMATCH")) { /* $^POSTMATCH */
 714           goto do_postmatch;
 715       }
 716       break;
 717     case '\015': /* $^MATCH */
 718         if (strEQ(remaining, "ATCH")) {
 719         goto do_match;
 720     } else {
 721         break;
 722     }
 723     case '`':
 724       do_prematch:
 725       paren = RX_BUFF_IDX_PREMATCH;
 726       goto maybegetparen;
 727     case '\'':
 728       do_postmatch:
 729       paren = RX_BUFF_IDX_POSTMATCH;
 730       goto maybegetparen;
 731     case '&':
 732       do_match:
 733       paren = RX_BUFF_IDX_FULLMATCH;
 734       goto maybegetparen;
 735     case '1': case '2': case '3': case '4':
 736     case '5': case '6': case '7': case '8': case '9':
 737       paren = atoi(mg->mg_ptr);
 738     maybegetparen:
 739         if (PL_curpm && (rx = PM_GETRE(PL_curpm))) {
 740       getparen:
 741         i = CALLREG_NUMBUF_LENGTH((REGEXP * const)rx, sv, paren);
 742
 743                 if (i < 0)
 744                     Perl_croak(aTHX_ "panic: magic_len: %"IVdf, (IV)i);
 745                 return i;
 746         } else {
 747                 if (ckWARN(WARN_UNINITIALIZED))
 748                     report_uninit(sv);
 749                 return 0;
 750         }
 751     case '+':
 752         if (PL_curpm && (rx = PM_GETRE(PL_curpm))) {
 753             paren = RX_LASTPAREN(rx);
 754             if (paren)
 755                 goto getparen;
 756         }
 757         return 0;
 758     case '\016': /* ^N */
 759         if (PL_curpm && (rx = PM_GETRE(PL_curpm))) {
 760             paren = RX_LASTCLOSEPAREN(rx);
 761             if (paren)
 762                 goto getparen;
 763         }
 764         return 0;
 765     }
 766     magic_get(sv,mg);
 767     if (!SvPOK(sv) && SvNIOK(sv)) {
 768         sv_2pv(sv, 0);
 769     }
 770     if (SvPOK(sv))
 771         return SvCUR(sv);
 772     return 0;
 773 }
 774
 775 #define SvRTRIM(sv) STMT_START { \
 776     if (SvPOK(sv)) { \
 777         STRLEN len = SvCUR(sv); \
 778         char * const p = SvPVX(sv); \
 779         while (len > 0 && isSPACE(p[len-1])) \
 780            --len; \
 781         SvCUR_set(sv, len); \
 782         p[len] = '\0'; \
 783     } \
 784 } STMT_END
 785
 786 void
 787 Perl_emulate_cop_io(pTHX_ const COP *const c, SV *const sv)
 788 {
 789     PERL_ARGS_ASSERT_EMULATE_COP_IO;
 790
 791     if (!(CopHINTS_get(c) & (HINT_LEXICAL_IO_IN|HINT_LEXICAL_IO_OUT)))
 792         sv_setsv(sv, &PL_sv_undef);
 793     else {
 794         sv_setpvs(sv, "");
 795         SvUTF8_off(sv);
 796         if ((CopHINTS_get(c) & HINT_LEXICAL_IO_IN)) {
 797             SV *const value = cop_hints_fetch_pvs(c, "open<", 0);
 798             assert(value);
 799             sv_catsv(sv, value);
 800         }
 801         sv_catpvs(sv, "\0");
 802         if ((CopHINTS_get(c) & HINT_LEXICAL_IO_OUT)) {
 803             SV *const value = cop_hints_fetch_pvs(c, "open>", 0);
 804             assert(value);
 805             sv_catsv(sv, value);
 806         }
 807     }
 808 }
 809
 810 int
 811 Perl_magic_get(pTHX_ SV *sv, MAGIC *mg)
 812 {
 813     dVAR;
 814     register I32 paren;
 815     register const char *s = NULL;
 816     register REGEXP *rx;
 817     const char * const remaining = mg->mg_ptr + 1;
 818     const char nextchar = *remaining;
 819
 820     PERL_ARGS_ASSERT_MAGIC_GET;
 821
 822     switch (*mg->mg_ptr) {
 823     case '\001':                /* ^A */
 824         sv_setsv(sv, PL_bodytarget);
 825         if (SvTAINTED(PL_bodytarget))
 826             SvTAINTED_on(sv);
 827         break;
 828     case '\003':                /* ^C, ^CHILD_ERROR_NATIVE */
 829         if (nextchar == '\0') {
 830             sv_setiv(sv, (IV)PL_minus_c);
 831         }
 832         else if (strEQ(remaining, "HILD_ERROR_NATIVE")) {
 833             sv_setiv(sv, (IV)STATUS_NATIVE);
 834         }
 835         break;
 836
 837     case '\004':                /* ^D */
 838         sv_setiv(sv, (IV)(PL_debug & DEBUG_MASK));
 839         break;
 840     case '\005':  /* ^E */
 841          if (nextchar == '\0') {
 842 #if defined(VMS)
 843              {
 844 #                 include <descrip.h>
 845 #                 include <starlet.h>
 846                   char msg[255];
 847                   $DESCRIPTOR(msgdsc,msg);
 848                   sv_setnv(sv,(NV) vaxc$errno);
 849                   if (sys$getmsg(vaxc$errno,&msgdsc.dsc$w_length,&msgdsc,0,0) & 1)
 850                        sv_setpvn(sv,msgdsc.dsc$a_pointer,msgdsc.dsc$w_length);
 851                   else
 852                        sv_setpvs(sv,"");
 853              }
 854 #elif defined(OS2)
 855              if (!(_emx_env & 0x200)) { /* Under DOS */
 856                   sv_setnv(sv, (NV)errno);
 857                   sv_setpv(sv, errno ? Strerror(errno) : "");
 858              } else {
 859                   if (errno != errno_isOS2) {
 860                        const int tmp = _syserrno();
 861                        if (tmp) /* 2nd call to _syserrno() makes it 0 */
 862                             Perl_rc = tmp;
 863                   }
 864                   sv_setnv(sv, (NV)Perl_rc);
 865                   sv_setpv(sv, os2error(Perl_rc));
 866              }
 867 #elif defined(WIN32)
 868              {
 869                   const DWORD dwErr = GetLastError();
 870                   sv_setnv(sv, (NV)dwErr);
 871                   if (dwErr) {
 872                        PerlProc_GetOSError(sv, dwErr);
 873                   }
 874                   else
 875                        sv_setpvs(sv, "");
 876                   SetLastError(dwErr);
 877              }
 878 #else
 879              {
 880                  dSAVE_ERRNO;
 881                  sv_setnv(sv, (NV)errno);
 882                  sv_setpv(sv, errno ? Strerror(errno) : "");
 883                  RESTORE_ERRNO;
 884              }
 885 #endif
 886              SvRTRIM(sv);
 887              SvNOK_on(sv);      /* what a wonderful hack! */
 888          }
 889          else if (strEQ(remaining, "NCODING"))
 890               sv_setsv(sv, PL_encoding);
 891          break;
 892     case '\006':                /* ^F */
 893         sv_setiv(sv, (IV)PL_maxsysfd);
 894         break;
 895     case '\007':                /* ^GLOBAL_PHASE */
 896         if (strEQ(remaining, "LOBAL_PHASE")) {
 897             sv_setpvn(sv, PL_phase_names[PL_phase],
 898                       strlen(PL_phase_names[PL_phase]));
 899         }
 900         break;
 901     case '\010':                /* ^H */
 902         sv_setiv(sv, (IV)PL_hints);
 903         break;
 904     case '\011':                /* ^I */ /* NOT \t in EBCDIC */
 905         sv_setpv(sv, PL_inplace); /* Will undefine sv if PL_inplace is NULL */
 906         break;
 907     case '\017':                /* ^O & ^OPEN */
 908         if (nextchar == '\0') {
 909             sv_setpv(sv, PL_osname);
 910             SvTAINTED_off(sv);
 911         }
 912         else if (strEQ(remaining, "PEN")) {
 913             Perl_emulate_cop_io(aTHX_ &PL_compiling, sv);
 914         }
 915         break;
 916     case '\020':
 917         if (nextchar == '\0') {       /* ^P */
 918             sv_setiv(sv, (IV)PL_perldb);
 919         } else if (strEQ(remaining, "REMATCH")) { /* $^PREMATCH */
 920             goto do_prematch_fetch;
 921         } else if (strEQ(remaining, "OSTMATCH")) { /* $^POSTMATCH */
 922             goto do_postmatch_fetch;
 923         }
 924         break;
 925     case '\023':                /* ^S */
 926         if (nextchar == '\0') {
 927             if (PL_parser && PL_parser->lex_state != LEX_NOTPARSING)
 928                 SvOK_off(sv);
 929             else if (PL_in_eval)
 930                 sv_setiv(sv, PL_in_eval & ~(EVAL_INREQUIRE));
 931             else
 932                 sv_setiv(sv, 0);
 933         }
 934         break;
 935     case '\024':                /* ^T */
 936         if (nextchar == '\0') {
 937 #ifdef BIG_TIME
 938             sv_setnv(sv, PL_basetime);
 939 #else
 940             sv_setiv(sv, (IV)PL_basetime);
 941 #endif
 942         }
 943         else if (strEQ(remaining, "AINT"))
 944             sv_setiv(sv, PL_tainting
 945                     ? (PL_taint_warn || PL_unsafe ? -1 : 1)
 946                     : 0);
 947         break;
 948     case '\025':                /* $^UNICODE, $^UTF8LOCALE, $^UTF8CACHE */
 949         if (strEQ(remaining, "NICODE"))
 950             sv_setuv(sv, (UV) PL_unicode);
 951         else if (strEQ(remaining, "TF8LOCALE"))
 952             sv_setuv(sv, (UV) PL_utf8locale);
 953         else if (strEQ(remaining, "TF8CACHE"))
 954             sv_setiv(sv, (IV) PL_utf8cache);
 955         break;
 956     case '\027':                /* ^W  & $^WARNING_BITS */
 957         if (nextchar == '\0')
 958             sv_setiv(sv, (IV)((PL_dowarn & G_WARN_ON) ? TRUE : FALSE));
 959         else if (strEQ(remaining, "ARNING_BITS")) {
 960             if (PL_compiling.cop_warnings == pWARN_NONE) {
 961                 sv_setpvn(sv, WARN_NONEstring, WARNsize) ;
 962             }
 963             else if (PL_compiling.cop_warnings == pWARN_STD) {
 964                 sv_setpvn(
 965                     sv,
 966                     (PL_dowarn & G_WARN_ON) ? WARN_ALLstring : WARN_NONEstring,
 967                     WARNsize
 968                 );
 969             }
 970             else if (PL_compiling.cop_warnings == pWARN_ALL) {
 971                 /* Get the bit mask for $warnings::Bits{all}, because
 972                  * it could have been extended by warnings::register */
 973                 HV * const bits=get_hv("warnings::Bits", 0);
 974                 if (bits) {
 975                     SV ** const bits_all = hv_fetchs(bits, "all", FALSE);
 976                     if (bits_all)
 977                         sv_setsv(sv, *bits_all);
 978                 }
 979                 else {
 980                     sv_setpvn(sv, WARN_ALLstring, WARNsize) ;
 981                 }
 982             }
 983             else {
 984                 sv_setpvn(sv, (char *) (PL_compiling.cop_warnings + 1),
 985                           *PL_compiling.cop_warnings);
 986             }
 987             SvPOK_only(sv);
 988         }
 989         break;
 990     case '\015': /* $^MATCH */
 991         if (strEQ(remaining, "ATCH")) {
 992     case '1': case '2': case '3': case '4':
 993     case '5': case '6': case '7': case '8': case '9': case '&':
 994             if (PL_curpm && (rx = PM_GETRE(PL_curpm))) {
 995                 /*
 996                  * Pre-threads, this was paren = atoi(GvENAME((const GV *)mg->mg_obj));
 997                  * XXX Does the new way break anything?
 998                  */
 999                 paren = atoi(mg->mg_ptr); /* $& is in [0] */
1000                 CALLREG_NUMBUF_FETCH(rx,paren,sv);
1001                 break;
1002             }
1003             sv_setsv(sv,&PL_sv_undef);
1004         }
1005         break;
1006     case '+':
1007         if (PL_curpm && (rx = PM_GETRE(PL_curpm))) {
1008             if (RX_LASTPAREN(rx)) {
1009                 CALLREG_NUMBUF_FETCH(rx,RX_LASTPAREN(rx),sv);
1010                 break;
1011             }
1012         }
1013         sv_setsv(sv,&PL_sv_undef);
1014         break;
1015     case '\016':                /* ^N */
1016         if (PL_curpm && (rx = PM_GETRE(PL_curpm))) {
1017             if (RX_LASTCLOSEPAREN(rx)) {
1018                 CALLREG_NUMBUF_FETCH(rx,RX_LASTCLOSEPAREN(rx),sv);
1019                 break;
1020             }
1021
1022         }
1023         sv_setsv(sv,&PL_sv_undef);
1024         break;
1025     case '`':
1026       do_prematch_fetch:
1027         if (PL_curpm && (rx = PM_GETRE(PL_curpm))) {
1028             CALLREG_NUMBUF_FETCH(rx,-2,sv);
1029             break;
1030         }
1031         sv_setsv(sv,&PL_sv_undef);
1032         break;
1033     case '\'':
1034       do_postmatch_fetch:
1035         if (PL_curpm && (rx = PM_GETRE(PL_curpm))) {
1036             CALLREG_NUMBUF_FETCH(rx,-1,sv);
1037             break;
1038         }
1039         sv_setsv(sv,&PL_sv_undef);
1040         break;
1041     case '.':
1042         if (GvIO(PL_last_in_gv)) {
1043             sv_setiv(sv, (IV)IoLINES(GvIOp(PL_last_in_gv)));
1044         }
1045         break;
1046     case '?':
1047         {
1048             sv_setiv(sv, (IV)STATUS_CURRENT);
1049 #ifdef COMPLEX_STATUS
1050             SvUPGRADE(sv, SVt_PVLV);
1051             LvTARGOFF(sv) = PL_statusvalue;
1052             LvTARGLEN(sv) = PL_statusvalue_vms;
1053 #endif
1054         }
1055         break;
1056     case '^':
1057         if (!isGV_with_GP(PL_defoutgv))
1058             s = "";
1059         else if (GvIOp(PL_defoutgv))
1060                 s = IoTOP_NAME(GvIOp(PL_defoutgv));
1061         if (s)
1062             sv_setpv(sv,s);
1063         else {
1064             sv_setpv(sv,GvENAME(PL_defoutgv));
1065             sv_catpvs(sv,"_TOP");
1066         }
1067         break;
1068     case '~':
1069         if (!isGV_with_GP(PL_defoutgv))
1070             s = "";
1071         else if (GvIOp(PL_defoutgv))
1072             s = IoFMT_NAME(GvIOp(PL_defoutgv));
1073         if (!s)
1074             s = GvENAME(PL_defoutgv);
1075         sv_setpv(sv,s);
1076         break;
1077     case '=':
1078         if (GvIO(PL_defoutgv))
1079             sv_setiv(sv, (IV)IoPAGE_LEN(GvIOp(PL_defoutgv)));
1080         break;
1081     case '-':
1082         if (GvIO(PL_defoutgv))
1083             sv_setiv(sv, (IV)IoLINES_LEFT(GvIOp(PL_defoutgv)));
1084         break;
1085     case '%':
1086         if (GvIO(PL_defoutgv))
1087             sv_setiv(sv, (IV)IoPAGE(GvIOp(PL_defoutgv)));
1088         break;
1089     case ':':
1090         break;
1091     case '/':
1092         break;
1093     case '[':
1094         sv_setiv(sv, (IV)CopARYBASE_get(PL_curcop));
1095         break;
1096     case '|':
1097         if (GvIO(PL_defoutgv))
1098             sv_setiv(sv, (IV)(IoFLAGS(GvIOp(PL_defoutgv)) & IOf_FLUSH) != 0 );
1099         break;
1100     case '\\':
1101         if (PL_ors_sv)
1102             sv_copypv(sv, PL_ors_sv);
1103         break;
1104     case '!':
1105         {
1106         dSAVE_ERRNO;
1107 #ifdef VMS
1108         sv_setnv(sv, (NV)((errno == EVMSERR) ? vaxc$errno : errno));
1109 #else
1110         sv_setnv(sv, (NV)errno);
1111 #endif
1112 #ifdef OS2
1113         if (errno == errno_isOS2 || errno == errno_isOS2_set)
1114             sv_setpv(sv, os2error(Perl_rc));
1115         else
1116 #endif
1117         sv_setpv(sv, errno ? Strerror(errno) : "");
1118         if (SvPOKp(sv))
1119             SvPOK_on(sv);    /* may have got removed during taint processing */
1120         RESTORE_ERRNO;
1121         }
1122
1123         SvRTRIM(sv);
1124         SvNOK_on(sv);   /* what a wonderful hack! */
1125         break;
1126     case '<':
1127         sv_setiv(sv, (IV)PL_uid);
1128         break;
1129     case '>':
1130         sv_setiv(sv, (IV)PL_euid);
1131         break;
1132     case '(':
1133         sv_setiv(sv, (IV)PL_gid);
1134         goto add_groups;
1135     case ')':
1136         sv_setiv(sv, (IV)PL_egid);
1137       add_groups:
1138 #ifdef HAS_GETGROUPS
1139         {
1140             Groups_t *gary = NULL;
1141             I32 i, num_groups = getgroups(0, gary);
1142             Newx(gary, num_groups, Groups_t);
1143             num_groups = getgroups(num_groups, gary);
1144             for (i = 0; i < num_groups; i++)
1145                 Perl_sv_catpvf(aTHX_ sv, " %"IVdf, (IV)gary[i]);
1146             Safefree(gary);
1147         }
1148         (void)SvIOK_on(sv);     /* what a wonderful hack! */
1149 #endif
1150         break;
1151     case '0':
1152         break;
1153     }
1154     return 0;
1155 }
1156
1157 int
1158 Perl_magic_getuvar(pTHX_ SV *sv, MAGIC *mg)
1159 {
1160     struct ufuncs * const uf = (struct ufuncs *)mg->mg_ptr;
1161
1162     PERL_ARGS_ASSERT_MAGIC_GETUVAR;
1163
1164     if (uf && uf->uf_val)
1165         (*uf->uf_val)(aTHX_ uf->uf_index, sv);
1166     return 0;
1167 }
1168
1169 int
1170 Perl_magic_setenv(pTHX_ SV *sv, MAGIC *mg)
1171 {
1172     dVAR;
1173     STRLEN len = 0, klen;
1174     const char *s = SvOK(sv) ? SvPV_const(sv,len) : "";
1175     const char * const ptr = MgPV_const(mg,klen);
1176     my_setenv(ptr, s);
1177
1178     PERL_ARGS_ASSERT_MAGIC_SETENV;
1179
1180 #ifdef DYNAMIC_ENV_FETCH
1181      /* We just undefd an environment var.  Is a replacement */
1182      /* waiting in the wings? */
1183     if (!len) {
1184         SV ** const valp = hv_fetch(GvHVn(PL_envgv), ptr, klen, FALSE);
1185         if (valp)
1186             s = SvOK(*valp) ? SvPV_const(*valp, len) : "";
1187     }
1188 #endif
1189
1190 #if !defined(OS2) && !defined(AMIGAOS) && !defined(WIN32) && !defined(MSDOS)
1191                             /* And you'll never guess what the dog had */
1192                             /*   in its mouth... */
1193     if (PL_tainting) {
1194         MgTAINTEDDIR_off(mg);
1195 #ifdef VMS
1196         if (s && klen == 8 && strEQ(ptr, "DCL$PATH")) {
1197             char pathbuf[256], eltbuf[256], *cp, *elt;
1198             int i = 0, j = 0;
1199
1200             my_strlcpy(eltbuf, s, sizeof(eltbuf));
1201             elt = eltbuf;
1202             do {          /* DCL$PATH may be a search list */
1203                 while (1) {   /* as may dev portion of any element */
1204                     if ( ((cp = strchr(elt,'[')) || (cp = strchr(elt,'<'))) ) {
1205                         if ( *(cp+1) == '.' || *(cp+1) == '-' ||
1206                              cando_by_name(S_IWUSR,0,elt) ) {
1207                             MgTAINTEDDIR_on(mg);
1208                             return 0;
1209                         }
1210                     }
1211                     if ((cp = strchr(elt, ':')) != NULL)
1212                         *cp = '\0';
1213                     if (my_trnlnm(elt, eltbuf, j++))
1214                         elt = eltbuf;
1215                     else
1216                         break;
1217                 }
1218                 j = 0;
1219             } while (my_trnlnm(s, pathbuf, i++) && (elt = pathbuf));
1220         }
1221 #endif /* VMS */
1222         if (s && klen == 4 && strEQ(ptr,"PATH")) {
1223             const char * const strend = s + len;
1224
1225             while (s < strend) {
1226                 char tmpbuf[256];
1227                 Stat_t st;
1228                 I32 i;
1229 #ifdef VMS  /* Hmm.  How do we get $Config{path_sep} from C? */
1230                 const char path_sep = '|';
1231 #else
1232                 const char path_sep = ':';
1233 #endif
1234                 s = delimcpy(tmpbuf, tmpbuf + sizeof tmpbuf,
1235                              s, strend, path_sep, &i);
1236                 s++;
1237                 if (i >= (I32)sizeof tmpbuf   /* too long -- assume the worst */
1238 #ifdef VMS
1239                       || !strchr(tmpbuf, ':') /* no colon thus no device name -- assume relative path */
1240 #else
1241                       || *tmpbuf != '/'       /* no starting slash -- assume relative path */
1242 #endif
1243                       || (PerlLIO_stat(tmpbuf, &st) == 0 && (st.st_mode & 2)) ) {
1244                     MgTAINTEDDIR_on(mg);
1245                     return 0;
1246                 }
1247             }
1248         }
1249     }
1250 #endif /* neither OS2 nor AMIGAOS nor WIN32 nor MSDOS */
1251
1252     return 0;
1253 }
1254
1255 int
1256 Perl_magic_clearenv(pTHX_ SV *sv, MAGIC *mg)
1257 {
1258     PERL_ARGS_ASSERT_MAGIC_CLEARENV;
1259     PERL_UNUSED_ARG(sv);
1260     my_setenv(MgPV_nolen_const(mg),NULL);
1261     return 0;
1262 }
1263
1264 int
1265 Perl_magic_set_all_env(pTHX_ SV *sv, MAGIC *mg)
1266 {
1267     dVAR;
1268     PERL_ARGS_ASSERT_MAGIC_SET_ALL_ENV;
1269     PERL_UNUSED_ARG(mg);
1270 #if defined(VMS)
1271     Perl_die(aTHX_ "Can't make list assignment to %%ENV on this system");
1272 #else
1273     if (PL_localizing) {
1274         HE* entry;
1275         my_clearenv();
1276         hv_iterinit(MUTABLE_HV(sv));
1277         while ((entry = hv_iternext(MUTABLE_HV(sv)))) {
1278             I32 keylen;
1279             my_setenv(hv_iterkey(entry, &keylen),
1280                       SvPV_nolen_const(hv_iterval(MUTABLE_HV(sv), entry)));
1281         }
1282     }
1283 #endif
1284     return 0;
1285 }
1286
1287 int
1288 Perl_magic_clear_all_env(pTHX_ SV *sv, MAGIC *mg)
1289 {
1290     dVAR;
1291     PERL_ARGS_ASSERT_MAGIC_CLEAR_ALL_ENV;
1292     PERL_UNUSED_ARG(sv);
1293     PERL_UNUSED_ARG(mg);
1294 #if defined(VMS)
1295     Perl_die(aTHX_ "Can't make list assignment to %%ENV on this system");
1296 #else
1297     my_clearenv();
1298 #endif
1299     return 0;
1300 }
1301
1302 #ifndef PERL_MICRO
1303 #ifdef HAS_SIGPROCMASK
1304 static void
1305 restore_sigmask(pTHX_ SV *save_sv)
1306 {
1307     const sigset_t * const ossetp = (const sigset_t *) SvPV_nolen_const( save_sv );
1308     (void)sigprocmask(SIG_SETMASK, ossetp, NULL);
1309 }
1310 #endif
1311 int
1312 Perl_magic_getsig(pTHX_ SV *sv, MAGIC *mg)
1313 {
1314     dVAR;
1315     /* Are we fetching a signal entry? */
1316     int i = (I16)mg->mg_private;
1317
1318     PERL_ARGS_ASSERT_MAGIC_GETSIG;
1319
1320     if (!i) {
1321         mg->mg_private = i = whichsig(MgPV_nolen_const(mg));
1322     }
1323
1324     if (i > 0) {
1325         if(PL_psig_ptr[i])
1326             sv_setsv(sv,PL_psig_ptr[i]);
1327         else {
1328             Sighandler_t sigstate = rsignal_state(i);
1329 #ifdef FAKE_PERSISTENT_SIGNAL_HANDLERS
1330             if (PL_sig_handlers_initted && PL_sig_ignoring[i])
1331                 sigstate = SIG_IGN;
1332 #endif
1333 #ifdef FAKE_DEFAULT_SIGNAL_HANDLERS
1334             if (PL_sig_handlers_initted && PL_sig_defaulting[i])
1335                 sigstate = SIG_DFL;
1336 #endif
1337             /* cache state so we don't fetch it again */
1338             if(sigstate == (Sighandler_t) SIG_IGN)
1339                 sv_setpvs(sv,"IGNORE");
1340             else
1341                 sv_setsv(sv,&PL_sv_undef);
1342             PL_psig_ptr[i] = SvREFCNT_inc_simple_NN(sv);
1343             SvTEMP_off(sv);
1344         }
1345     }
1346     return 0;
1347 }
1348 int
1349 Perl_magic_clearsig(pTHX_ SV *sv, MAGIC *mg)
1350 {
1351     PERL_ARGS_ASSERT_MAGIC_CLEARSIG;
1352     PERL_UNUSED_ARG(sv);
1353
1354     magic_setsig(NULL, mg);
1355     return sv_unmagic(sv, mg->mg_type);
1356 }
1357
1358 Signal_t
1359 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
1360 Perl_csighandler(int sig, siginfo_t *sip PERL_UNUSED_DECL, void *uap PERL_UNUSED_DECL)
1361 #else
1362 Perl_csighandler(int sig)
1363 #endif
1364 {
1365 #ifdef PERL_GET_SIG_CONTEXT
1366     dTHXa(PERL_GET_SIG_CONTEXT);
1367 #else
1368     dTHX;
1369 #endif
1370 #ifdef FAKE_PERSISTENT_SIGNAL_HANDLERS
1371     (void) rsignal(sig, PL_csighandlerp);
1372     if (PL_sig_ignoring[sig]) return;
1373 #endif
1374 #ifdef FAKE_DEFAULT_SIGNAL_HANDLERS
1375     if (PL_sig_defaulting[sig])
1376 #ifdef KILL_BY_SIGPRC
1377             exit((Perl_sig_to_vmscondition(sig)&STS$M_COND_ID)|STS$K_SEVERE|STS$M_INHIB_MSG);
1378 #else
1379             exit(1);
1380 #endif
1381 #endif
1382     if (
1383 #ifdef SIGILL
1384            sig == SIGILL ||
1385 #endif
1386 #ifdef SIGBUS
1387            sig == SIGBUS ||
1388 #endif
1389 #ifdef SIGSEGV
1390            sig == SIGSEGV ||
1391 #endif
1392            (PL_signals & PERL_SIGNALS_UNSAFE_FLAG))
1393         /* Call the perl level handler now--
1394          * with risk we may be in malloc() or being destructed etc. */
1395 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
1396         (*PL_sighandlerp)(sig, NULL, NULL);
1397 #else
1398         (*PL_sighandlerp)(sig);
1399 #endif
1400     else {
1401         if (!PL_psig_pend) return;
1402         /* Set a flag to say this signal is pending, that is awaiting delivery after
1403          * the current Perl opcode completes */
1404         PL_psig_pend[sig]++;
1405
1406 #ifndef SIG_PENDING_DIE_COUNT
1407 #  define SIG_PENDING_DIE_COUNT 120
1408 #endif
1409         /* Add one to say _a_ signal is pending */
1410         if (++PL_sig_pending >= SIG_PENDING_DIE_COUNT)
1411             Perl_croak(aTHX_ "Maximal count of pending signals (%lu) exceeded",
1412                        (unsigned long)SIG_PENDING_DIE_COUNT);
1413     }
1414 }
1415
1416 #if defined(FAKE_PERSISTENT_SIGNAL_HANDLERS) || defined(FAKE_DEFAULT_SIGNAL_HANDLERS)
1417 void
1418 Perl_csighandler_init(void)
1419 {
1420     int sig;
1421     if (PL_sig_handlers_initted) return;
1422
1423     for (sig = 1; sig < SIG_SIZE; sig++) {
1424 #ifdef FAKE_DEFAULT_SIGNAL_HANDLERS
1425         dTHX;
1426         PL_sig_defaulting[sig] = 1;
1427         (void) rsignal(sig, PL_csighandlerp);
1428 #endif
1429 #ifdef FAKE_PERSISTENT_SIGNAL_HANDLERS
1430         PL_sig_ignoring[sig] = 0;
1431 #endif
1432     }
1433     PL_sig_handlers_initted = 1;
1434 }
1435 #endif
1436
1437 void
1438 Perl_despatch_signals(pTHX)
1439 {
1440     dVAR;
1441     int sig;
1442     PL_sig_pending = 0;
1443     for (sig = 1; sig < SIG_SIZE; sig++) {
1444         if (PL_psig_pend[sig]) {
1445             dSAVE_ERRNO;
1446             PERL_BLOCKSIG_ADD(set, sig);
1447             PL_psig_pend[sig] = 0;
1448             PERL_BLOCKSIG_BLOCK(set);
1449 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
1450             (*PL_sighandlerp)(sig, NULL, NULL);
1451 #else
1452             (*PL_sighandlerp)(sig);
1453 #endif
1454             PERL_BLOCKSIG_UNBLOCK(set);
1455             RESTORE_ERRNO;
1456         }
1457     }
1458 }
1459
1460 /* sv of NULL signifies that we're acting as magic_clearsig.  */
1461 int
1462 Perl_magic_setsig(pTHX_ SV *sv, MAGIC *mg)
1463 {
1464     dVAR;
1465     I32 i;
1466     SV** svp = NULL;
1467     /* Need to be careful with SvREFCNT_dec(), because that can have side
1468      * effects (due to closures). We must make sure that the new disposition
1469      * is in place before it is called.
1470      */
1471     SV* to_dec = NULL;
1472     STRLEN len;
1473 #ifdef HAS_SIGPROCMASK
1474     sigset_t set, save;
1475     SV* save_sv;
1476 #endif
1477     register const char *s = MgPV_const(mg,len);
1478
1479     PERL_ARGS_ASSERT_MAGIC_SETSIG;
1480
1481     if (*s == '_') {
1482         if (strEQ(s,"__DIE__"))
1483             svp = &PL_diehook;
1484         else if (strEQ(s,"__WARN__")
1485                  && (sv ? 1 : PL_warnhook != PERL_WARNHOOK_FATAL)) {
1486             /* Merge the existing behaviours, which are as follows:
1487                magic_setsig, we always set svp to &PL_warnhook
1488                (hence we always change the warnings handler)
1489                For magic_clearsig, we don't change the warnings handler if it's
1490                set to the &PL_warnhook.  */
1491             svp = &PL_warnhook;
1492         } else if (sv)
1493             Perl_croak(aTHX_ "No such hook: %s", s);
1494         i = 0;
1495         if (svp && *svp) {
1496             if (*svp != PERL_WARNHOOK_FATAL)
1497                 to_dec = *svp;
1498             *svp = NULL;
1499         }
1500     }
1501     else {
1502         i = (I16)mg->mg_private;
1503         if (!i) {
1504             i = whichsig(s);    /* ...no, a brick */
1505             mg->mg_private = (U16)i;
1506         }
1507         if (i <= 0) {
1508             if (sv)
1509                 Perl_ck_warner(aTHX_ packWARN(WARN_SIGNAL), "No such signal: SIG%s", s);
1510             return 0;
1511         }
1512 #ifdef HAS_SIGPROCMASK
1513         /* Avoid having the signal arrive at a bad time, if possible. */
1514         sigemptyset(&set);
1515         sigaddset(&set,i);
1516         sigprocmask(SIG_BLOCK, &set, &save);
1517         ENTER;
1518         save_sv = newSVpvn((char *)(&save), sizeof(sigset_t));
1519         SAVEFREESV(save_sv);
1520         SAVEDESTRUCTOR_X(restore_sigmask, save_sv);
1521 #endif
1522         PERL_ASYNC_CHECK();
1523 #if defined(FAKE_PERSISTENT_SIGNAL_HANDLERS) || defined(FAKE_DEFAULT_SIGNAL_HANDLERS)
1524         if (!PL_sig_handlers_initted) Perl_csighandler_init();
1525 #endif
1526 #ifdef FAKE_PERSISTENT_SIGNAL_HANDLERS
1527         PL_sig_ignoring[i] = 0;
1528 #endif
1529 #ifdef FAKE_DEFAULT_SIGNAL_HANDLERS
1530         PL_sig_defaulting[i] = 0;
1531 #endif
1532         to_dec = PL_psig_ptr[i];
1533         if (sv) {
1534             PL_psig_ptr[i] = SvREFCNT_inc_simple_NN(sv);
1535             SvTEMP_off(sv); /* Make sure it doesn't go away on us */
1536
1537             /* Signals don't change name during the program's execution, so once
1538                they're cached in the appropriate slot of PL_psig_name, they can
1539                stay there.
1540
1541                Ideally we'd find some way of making SVs at (C) compile time, or
1542                at least, doing most of the work.  */
1543             if (!PL_psig_name[i]) {
1544                 PL_psig_name[i] = newSVpvn(s, len);
1545                 SvREADONLY_on(PL_psig_name[i]);
1546             }
1547         } else {
1548             SvREFCNT_dec(PL_psig_name[i]);
1549             PL_psig_name[i] = NULL;
1550             PL_psig_ptr[i] = NULL;
1551         }
1552     }
1553     if (sv && (isGV_with_GP(sv) || SvROK(sv))) {
1554         if (i) {
1555             (void)rsignal(i, PL_csighandlerp);
1556         }
1557         else
1558             *svp = SvREFCNT_inc_simple_NN(sv);
1559     } else {
1560         if (sv && SvOK(sv)) {
1561             s = SvPV_force(sv, len);
1562         } else {
1563             sv = NULL;
1564         }
1565         if (sv && strEQ(s,"IGNORE")) {
1566             if (i) {
1567 #ifdef FAKE_PERSISTENT_SIGNAL_HANDLERS
1568                 PL_sig_ignoring[i] = 1;
1569                 (void)rsignal(i, PL_csighandlerp);
1570 #else
1571                 (void)rsignal(i, (Sighandler_t) SIG_IGN);
1572 #endif
1573             }
1574         }
1575         else if (!sv || strEQ(s,"DEFAULT") || !len) {
1576             if (i) {
1577 #ifdef FAKE_DEFAULT_SIGNAL_HANDLERS
1578                 PL_sig_defaulting[i] = 1;
1579                 (void)rsignal(i, PL_csighandlerp);
1580 #else
1581                 (void)rsignal(i, (Sighandler_t) SIG_DFL);
1582 #endif
1583             }
1584         }
1585         else {
1586             /*
1587              * We should warn if HINT_STRICT_REFS, but without
1588              * access to a known hint bit in a known OP, we can't
1589              * tell whether HINT_STRICT_REFS is in force or not.
1590              */
1591             if (!strchr(s,':') && !strchr(s,'\''))
1592                 Perl_sv_insert_flags(aTHX_ sv, 0, 0, STR_WITH_LEN("main::"),
1593                                      SV_GMAGIC);
1594             if (i)
1595                 (void)rsignal(i, PL_csighandlerp);
1596             else
1597                 *svp = SvREFCNT_inc_simple_NN(sv);
1598         }
1599     }
1600
1601 #ifdef HAS_SIGPROCMASK
1602     if(i)
1603         LEAVE;
1604 #endif
1605     SvREFCNT_dec(to_dec);
1606     return 0;
1607 }
1608 #endif /* !PERL_MICRO */
1609
1610 int
1611 Perl_magic_setisa(pTHX_ SV *sv, MAGIC *mg)
1612 {
1613     dVAR;
1614     PERL_ARGS_ASSERT_MAGIC_SETISA;
1615     PERL_UNUSED_ARG(sv);
1616
1617     /* Skip _isaelem because _isa will handle it shortly */
1618     if (PL_delaymagic & DM_ARRAY_ISA && mg->mg_type == PERL_MAGIC_isaelem)
1619         return 0;
1620
1621     return magic_clearisa(NULL, mg);
1622 }
1623
1624 /* sv of NULL signifies that we're acting as magic_setisa.  */
1625 int
1626 Perl_magic_clearisa(pTHX_ SV *sv, MAGIC *mg)
1627 {
1628     dVAR;
1629     HV* stash;
1630
1631     PERL_ARGS_ASSERT_MAGIC_CLEARISA;
1632
1633     /* Bail out if destruction is going on */
1634     if(PL_phase == PERL_PHASE_DESTRUCT) return 0;
1635
1636     if (sv)
1637         av_clear(MUTABLE_AV(sv));
1638
1639     if (SvTYPE(mg->mg_obj) != SVt_PVGV && SvSMAGICAL(mg->mg_obj))
1640         /* This occurs with setisa_elem magic, which calls this
1641            same function. */
1642         mg = mg_find(mg->mg_obj, PERL_MAGIC_isa);
1643
1644     if (SvTYPE(mg->mg_obj) == SVt_PVAV) { /* multiple stashes */
1645         SV **svp = AvARRAY((AV *)mg->mg_obj);
1646         I32 items = AvFILLp((AV *)mg->mg_obj) + 1;
1647         while (items--) {
1648             stash = GvSTASH((GV *)*svp++);
1649             if (stash && HvENAME(stash)) mro_isa_changed_in(stash);
1650         }
1651
1652         return 0;
1653     }
1654
1655     stash = GvSTASH(
1656         (const GV *)mg->mg_obj
1657     );
1658
1659     /* The stash may have been detached from the symbol table, so check its
1660        name before doing anything. */
1661     if (stash && HvENAME_get(stash))
1662         mro_isa_changed_in(stash);
1663
1664     return 0;
1665 }
1666
1667 int
1668 Perl_magic_setamagic(pTHX_ SV *sv, MAGIC *mg)
1669 {
1670     dVAR;
1671     PERL_ARGS_ASSERT_MAGIC_SETAMAGIC;
1672     PERL_UNUSED_ARG(sv);
1673     PERL_UNUSED_ARG(mg);
1674     PL_amagic_generation++;
1675
1676     return 0;
1677 }
1678
1679 int
1680 Perl_magic_getnkeys(pTHX_ SV *sv, MAGIC *mg)
1681 {
1682     HV * const hv = MUTABLE_HV(LvTARG(sv));
1683     I32 i = 0;
1684
1685     PERL_ARGS_ASSERT_MAGIC_GETNKEYS;
1686     PERL_UNUSED_ARG(mg);
1687
1688     if (hv) {
1689          (void) hv_iterinit(hv);
1690          if (! SvTIED_mg((const SV *)hv, PERL_MAGIC_tied))
1691              i = HvKEYS(hv);
1692          else {
1693              while (hv_iternext(hv))
1694                  i++;
1695          }
1696     }
1697
1698     sv_setiv(sv, (IV)i);
1699     return 0;
1700 }
1701
1702 int
1703 Perl_magic_setnkeys(pTHX_ SV *sv, MAGIC *mg)
1704 {
1705     PERL_ARGS_ASSERT_MAGIC_SETNKEYS;
1706     PERL_UNUSED_ARG(mg);
1707     if (LvTARG(sv)) {
1708         hv_ksplit(MUTABLE_HV(LvTARG(sv)), SvIV(sv));
1709     }
1710     return 0;
1711 }
1712
1713 /*
1714 =for apidoc magic_methcall
1715
1716 Invoke a magic method (like FETCH).
1717
1718 * sv and mg are the tied thinggy and the tie magic;
1719 * meth is the name of the method to call;
1720 * argc is the number of args (in addition to $self) to pass to the method;
1721        the args themselves are any values following the argc argument.
1722 * flags:
1723     G_DISCARD:     invoke method with G_DISCARD flag and don't return a value
1724     G_UNDEF_FILL:  fill the stack with argc pointers to PL_sv_undef.
1725
1726 Returns the SV (if any) returned by the method, or NULL on failure.
1727
1728
1729 =cut
1730 */
1731
1732 SV*
1733 Perl_magic_methcall(pTHX_ SV *sv, const MAGIC *mg, const char *meth, U32 flags,
1734                     U32 argc, ...)
1735 {
1736     dVAR;
1737     dSP;
1738     SV* ret = NULL;
1739
1740     PERL_ARGS_ASSERT_MAGIC_METHCALL;
1741
1742     ENTER;
1743     PUSHSTACKi(PERLSI_MAGIC);
1744     PUSHMARK(SP);
1745
1746     EXTEND(SP, argc+1);
1747     PUSHs(SvTIED_obj(sv, mg));
1748     if (flags & G_UNDEF_FILL) {
1749         while (argc--) {
1750             PUSHs(&PL_sv_undef);
1751         }
1752     } else if (argc > 0) {
1753         va_list args;
1754         va_start(args, argc);
1755
1756         do {
1757             SV *const sv = va_arg(args, SV *);
1758             PUSHs(sv);
1759         } while (--argc);
1760
1761         va_end(args);
1762     }
1763     PUTBACK;
1764     if (flags & G_DISCARD) {
1765         call_method(meth, G_SCALAR|G_DISCARD);
1766     }
1767     else {
1768         if (call_method(meth, G_SCALAR))
1769             ret = *PL_stack_sp--;
1770     }
1771     POPSTACK;
1772     LEAVE;
1773     return ret;
1774 }
1775
1776
1777 /* wrapper for magic_methcall that creates the first arg */
1778
1779 STATIC SV*
1780 S_magic_methcall1(pTHX_ SV *sv, const MAGIC *mg, const char *meth, U32 flags,
1781     int n, SV *val)
1782 {
1783     dVAR;
1784     SV* arg1 = NULL;
1785
1786     PERL_ARGS_ASSERT_MAGIC_METHCALL1;
1787
1788     if (mg->mg_ptr) {
1789         if (mg->mg_len >= 0) {
1790             arg1 = newSVpvn_flags(mg->mg_ptr, mg->mg_len, SVs_TEMP);
1791         }
1792         else if (mg->mg_len == HEf_SVKEY)
1793             arg1 = MUTABLE_SV(mg->mg_ptr);
1794     }
1795     else if (mg->mg_type == PERL_MAGIC_tiedelem) {
1796         arg1 = newSViv((IV)(mg->mg_len));
1797         sv_2mortal(arg1);
1798     }
1799     if (!arg1) {
1800         return Perl_magic_methcall(aTHX_ sv, mg, meth, flags, n - 1, val);
1801     }
1802     return Perl_magic_methcall(aTHX_ sv, mg, meth, flags, n, arg1, val);
1803 }
1804
1805 STATIC int
1806 S_magic_methpack(pTHX_ SV *sv, const MAGIC *mg, const char *meth)
1807 {
1808     dVAR;
1809     SV* ret;
1810
1811     PERL_ARGS_ASSERT_MAGIC_METHPACK;
1812
1813     ret = magic_methcall1(sv, mg, meth, 0, 1, NULL);
1814     if (ret)
1815         sv_setsv(sv, ret);
1816     return 0;
1817 }
1818
1819 int
1820 Perl_magic_getpack(pTHX_ SV *sv, MAGIC *mg)
1821 {
1822     PERL_ARGS_ASSERT_MAGIC_GETPACK;
1823
1824     if (mg->mg_type == PERL_MAGIC_tiedelem)
1825         mg->mg_flags |= MGf_GSKIP;
1826     magic_methpack(sv,mg,"FETCH");
1827     return 0;
1828 }
1829
1830 int
1831 Perl_magic_setpack(pTHX_ SV *sv, MAGIC *mg)
1832 {
1833     dVAR;
1834     MAGIC *tmg;
1835     SV    *val;
1836
1837     PERL_ARGS_ASSERT_MAGIC_SETPACK;
1838
1839     /* in the code C<$tied{foo} = $val>, the "thing" that gets passed to
1840      * STORE() is not $val, but rather a PVLV (the sv in this call), whose
1841      * public flags indicate its value based on copying from $val. Doing
1842      * mg_set() on the PVLV temporarily does SvMAGICAL_off(), then calls us.
1843      * So STORE()'s $_[2] arg is a temporarily disarmed PVLV. This goes
1844      * wrong if $val happened to be tainted, as sv hasn't got magic
1845      * enabled, even though taint magic is in the chain. In which case,
1846      * fake up a temporary tainted value (this is easier than temporarily
1847      * re-enabling magic on sv). */
1848
1849     if (PL_tainting && (tmg = mg_find(sv, PERL_MAGIC_taint))
1850         && (tmg->mg_len & 1))
1851     {
1852         val = sv_mortalcopy(sv);
1853         SvTAINTED_on(val);
1854     }
1855     else
1856         val = sv;
1857
1858     magic_methcall1(sv, mg, "STORE", G_DISCARD, 2, val);
1859     return 0;
1860 }
1861
1862 int
1863 Perl_magic_clearpack(pTHX_ SV *sv, MAGIC *mg)
1864 {
1865     PERL_ARGS_ASSERT_MAGIC_CLEARPACK;
1866
1867     return magic_methpack(sv,mg,"DELETE");
1868 }
1869
1870
1871 U32
1872 Perl_magic_sizepack(pTHX_ SV *sv, MAGIC *mg)
1873 {
1874     dVAR;
1875     I32 retval = 0;
1876     SV* retsv;
1877
1878     PERL_ARGS_ASSERT_MAGIC_SIZEPACK;
1879
1880     retsv = magic_methcall1(sv, mg, "FETCHSIZE", 0, 1, NULL);
1881     if (retsv) {
1882         retval = SvIV(retsv)-1;
1883         if (retval < -1)
1884             Perl_croak(aTHX_ "FETCHSIZE returned a negative value");
1885     }
1886     return (U32) retval;
1887 }
1888
1889 int
1890 Perl_magic_wipepack(pTHX_ SV *sv, MAGIC *mg)
1891 {
1892     dVAR;
1893
1894     PERL_ARGS_ASSERT_MAGIC_WIPEPACK;
1895
1896     Perl_magic_methcall(aTHX_ sv, mg, "CLEAR", G_DISCARD, 0);
1897     return 0;
1898 }
1899
1900 int
1901 Perl_magic_nextpack(pTHX_ SV *sv, MAGIC *mg, SV *key)
1902 {
1903     dVAR;
1904     SV* ret;
1905
1906     PERL_ARGS_ASSERT_MAGIC_NEXTPACK;
1907
1908     ret = SvOK(key) ? Perl_magic_methcall(aTHX_ sv, mg, "NEXTKEY", 0, 1, key)
1909         : Perl_magic_methcall(aTHX_ sv, mg, "FIRSTKEY", 0, 0);
1910     if (ret)
1911         sv_setsv(key,ret);
1912     return 0;
1913 }
1914
1915 int
1916 Perl_magic_existspack(pTHX_ SV *sv, const MAGIC *mg)
1917 {
1918     PERL_ARGS_ASSERT_MAGIC_EXISTSPACK;
1919
1920     return magic_methpack(sv,mg,"EXISTS");
1921 }
1922
1923 SV *
1924 Perl_magic_scalarpack(pTHX_ HV *hv, MAGIC *mg)
1925 {
1926     dVAR;
1927     SV *retval;
1928     SV * const tied = SvTIED_obj(MUTABLE_SV(hv), mg);
1929     HV * const pkg = SvSTASH((const SV *)SvRV(tied));
1930
1931     PERL_ARGS_ASSERT_MAGIC_SCALARPACK;
1932
1933     if (!gv_fetchmethod_autoload(pkg, "SCALAR", FALSE)) {
1934         SV *key;
1935         if (HvEITER_get(hv))
1936             /* we are in an iteration so the hash cannot be empty */
1937             return &PL_sv_yes;
1938         /* no xhv_eiter so now use FIRSTKEY */
1939         key = sv_newmortal();
1940         magic_nextpack(MUTABLE_SV(hv), mg, key);
1941         HvEITER_set(hv, NULL);     /* need to reset iterator */
1942         return SvOK(key) ? &PL_sv_yes : &PL_sv_no;
1943     }
1944
1945     /* there is a SCALAR method that we can call */
1946     retval = Perl_magic_methcall(aTHX_ MUTABLE_SV(hv), mg, "SCALAR", 0, 0);
1947     if (!retval)
1948         retval = &PL_sv_undef;
1949     return retval;
1950 }
1951
1952 int
1953 Perl_magic_setdbline(pTHX_ SV *sv, MAGIC *mg)
1954 {
1955     dVAR;
1956     GV * const gv = PL_DBline;
1957     const I32 i = SvTRUE(sv);
1958     SV ** const svp = av_fetch(GvAV(gv),
1959                      atoi(MgPV_nolen_const(mg)), FALSE);
1960
1961     PERL_ARGS_ASSERT_MAGIC_SETDBLINE;
1962
1963     if (svp && SvIOKp(*svp)) {
1964         OP * const o = INT2PTR(OP*,SvIVX(*svp));
1965         if (o) {
1966             /* set or clear breakpoint in the relevant control op */
1967             if (i)
1968                 o->op_flags |= OPf_SPECIAL;
1969             else
1970                 o->op_flags &= ~OPf_SPECIAL;
1971         }
1972     }
1973     return 0;
1974 }
1975
1976 int
1977 Perl_magic_getarylen(pTHX_ SV *sv, const MAGIC *mg)
1978 {
1979     dVAR;
1980     AV * const obj = MUTABLE_AV(mg->mg_obj);
1981
1982     PERL_ARGS_ASSERT_MAGIC_GETARYLEN;
1983
1984     if (obj) {
1985         sv_setiv(sv, AvFILL(obj) + CopARYBASE_get(PL_curcop));
1986     } else {
1987         SvOK_off(sv);
1988     }
1989     return 0;
1990 }
1991
1992 int
1993 Perl_magic_setarylen(pTHX_ SV *sv, MAGIC *mg)
1994 {
1995     dVAR;
1996     AV * const obj = MUTABLE_AV(mg->mg_obj);
1997
1998     PERL_ARGS_ASSERT_MAGIC_SETARYLEN;
1999
2000     if (obj) {
2001         av_fill(obj, SvIV(sv) - CopARYBASE_get(PL_curcop));
2002     } else {
2003         Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
2004                        "Attempt to set length of freed array");
2005     }
2006     return 0;
2007 }
2008
2009 int
2010 Perl_magic_freearylen_p(pTHX_ SV *sv, MAGIC *mg)
2011 {
2012     dVAR;
2013
2014     PERL_ARGS_ASSERT_MAGIC_FREEARYLEN_P;
2015     PERL_UNUSED_ARG(sv);
2016
2017     /* during global destruction, mg_obj may already have been freed */
2018     if (PL_in_clean_all)
2019         return 0;
2020
2021     mg = mg_find (mg->mg_obj, PERL_MAGIC_arylen);
2022
2023     if (mg) {
2024         /* arylen scalar holds a pointer back to the array, but doesn't own a
2025            reference. Hence the we (the array) are about to go away with it
2026            still pointing at us. Clear its pointer, else it would be pointing
2027            at free memory. See the comment in sv_magic about reference loops,
2028            and why it can't own a reference to us.  */
2029         mg->mg_obj = 0;
2030     }
2031     return 0;
2032 }
2033
2034 int
2035 Perl_magic_getpos(pTHX_ SV *sv, MAGIC *mg)
2036 {
2037     dVAR;
2038     SV* const lsv = LvTARG(sv);
2039
2040     PERL_ARGS_ASSERT_MAGIC_GETPOS;
2041     PERL_UNUSED_ARG(mg);
2042
2043     if (SvTYPE(lsv) >= SVt_PVMG && SvMAGIC(lsv)) {
2044         MAGIC * const found = mg_find(lsv, PERL_MAGIC_regex_global);
2045         if (found && found->mg_len >= 0) {
2046             I32 i = found->mg_len;
2047             if (DO_UTF8(lsv))
2048                 sv_pos_b2u(lsv, &i);
2049             sv_setiv(sv, i + CopARYBASE_get(PL_curcop));
2050             return 0;
2051         }
2052     }
2053     SvOK_off(sv);
2054     return 0;
2055 }
2056
2057 int
2058 Perl_magic_setpos(pTHX_ SV *sv, MAGIC *mg)
2059 {
2060     dVAR;
2061     SV* const lsv = LvTARG(sv);
2062     SSize_t pos;
2063     STRLEN len;
2064     STRLEN ulen = 0;
2065     MAGIC* found;
2066
2067     PERL_ARGS_ASSERT_MAGIC_SETPOS;
2068     PERL_UNUSED_ARG(mg);
2069
2070     if (SvTYPE(lsv) >= SVt_PVMG && SvMAGIC(lsv))
2071         found = mg_find(lsv, PERL_MAGIC_regex_global);
2072     else
2073         found = NULL;
2074     if (!found) {
2075         if (!SvOK(sv))
2076             return 0;
2077 #ifdef PERL_OLD_COPY_ON_WRITE
2078     if (SvIsCOW(lsv))
2079         sv_force_normal_flags(lsv, 0);
2080 #endif
2081         found = sv_magicext(lsv, NULL, PERL_MAGIC_regex_global, &PL_vtbl_mglob,
2082                             NULL, 0);
2083     }
2084     else if (!SvOK(sv)) {
2085         found->mg_len = -1;
2086         return 0;
2087     }
2088     len = SvPOK(lsv) ? SvCUR(lsv) : sv_len(lsv);
2089
2090     pos = SvIV(sv) - CopARYBASE_get(PL_curcop);
2091
2092     if (DO_UTF8(lsv)) {
2093         ulen = sv_len_utf8(lsv);
2094         if (ulen)
2095             len = ulen;
2096     }
2097
2098     if (pos < 0) {
2099         pos += len;
2100         if (pos < 0)
2101             pos = 0;
2102     }
2103     else if (pos > (SSize_t)len)
2104         pos = len;
2105
2106     if (ulen) {
2107         I32 p = pos;
2108         sv_pos_u2b(lsv, &p, 0);
2109         pos = p;
2110     }
2111
2112     found->mg_len = pos;
2113     found->mg_flags &= ~MGf_MINMATCH;
2114
2115     return 0;
2116 }
2117
2118 int
2119 Perl_magic_getsubstr(pTHX_ SV *sv, MAGIC *mg)
2120 {
2121     STRLEN len;
2122     SV * const lsv = LvTARG(sv);
2123     const char * const tmps = SvPV_const(lsv,len);
2124     STRLEN offs = LvTARGOFF(sv);
2125     STRLEN rem = LvTARGLEN(sv);
2126
2127     PERL_ARGS_ASSERT_MAGIC_GETSUBSTR;
2128     PERL_UNUSED_ARG(mg);
2129
2130     if (SvUTF8(lsv))
2131         offs = sv_pos_u2b_flags(lsv, offs, &rem, SV_CONST_RETURN);
2132     if (offs > len)
2133         offs = len;
2134     if (rem > len - offs)
2135         rem = len - offs;
2136     sv_setpvn(sv, tmps + offs, rem);
2137     if (SvUTF8(lsv))
2138         SvUTF8_on(sv);
2139     return 0;
2140 }
2141
2142 int
2143 Perl_magic_setsubstr(pTHX_ SV *sv, MAGIC *mg)
2144 {
2145     dVAR;
2146     STRLEN len;
2147     const char * const tmps = SvPV_const(sv, len);
2148     SV * const lsv = LvTARG(sv);
2149     STRLEN lvoff = LvTARGOFF(sv);
2150     STRLEN lvlen = LvTARGLEN(sv);
2151
2152     PERL_ARGS_ASSERT_MAGIC_SETSUBSTR;
2153     PERL_UNUSED_ARG(mg);
2154
2155     if (DO_UTF8(sv)) {
2156         sv_utf8_upgrade(lsv);
2157         lvoff = sv_pos_u2b_flags(lsv, lvoff, &lvlen, SV_CONST_RETURN);
2158         sv_insert(lsv, lvoff, lvlen, tmps, len);
2159         LvTARGLEN(sv) = sv_len_utf8(sv);
2160         SvUTF8_on(lsv);
2161     }
2162     else if (lsv && SvUTF8(lsv)) {
2163         const char *utf8;
2164         lvoff = sv_pos_u2b_flags(lsv, lvoff, &lvlen, SV_CONST_RETURN);
2165         LvTARGLEN(sv) = len;
2166         utf8 = (char*)bytes_to_utf8((U8*)tmps, &len);
2167         sv_insert(lsv, lvoff, lvlen, utf8, len);
2168         Safefree(utf8);
2169     }
2170     else {
2171         sv_insert(lsv, lvoff, lvlen, tmps, len);
2172         LvTARGLEN(sv) = len;
2173     }
2174
2175     return 0;
2176 }
2177
2178 int
2179 Perl_magic_gettaint(pTHX_ SV *sv, MAGIC *mg)
2180 {
2181     dVAR;
2182
2183     PERL_ARGS_ASSERT_MAGIC_GETTAINT;
2184     PERL_UNUSED_ARG(sv);
2185
2186     TAINT_IF((PL_localizing != 1) && (mg->mg_len & 1));
2187     return 0;
2188 }
2189
2190 int
2191 Perl_magic_settaint(pTHX_ SV *sv, MAGIC *mg)
2192 {
2193     dVAR;
2194
2195     PERL_ARGS_ASSERT_MAGIC_SETTAINT;
2196     PERL_UNUSED_ARG(sv);
2197
2198     /* update taint status */
2199     if (PL_tainted)
2200         mg->mg_len |= 1;
2201     else
2202         mg->mg_len &= ~1;
2203     return 0;
2204 }
2205
2206 int
2207 Perl_magic_getvec(pTHX_ SV *sv, MAGIC *mg)
2208 {
2209     SV * const lsv = LvTARG(sv);
2210
2211     PERL_ARGS_ASSERT_MAGIC_GETVEC;
2212     PERL_UNUSED_ARG(mg);
2213
2214     if (lsv)
2215         sv_setuv(sv, do_vecget(lsv, LvTARGOFF(sv), LvTARGLEN(sv)));
2216     else
2217         SvOK_off(sv);
2218
2219     return 0;
2220 }
2221
2222 int
2223 Perl_magic_setvec(pTHX_ SV *sv, MAGIC *mg)
2224 {
2225     PERL_ARGS_ASSERT_MAGIC_SETVEC;
2226     PERL_UNUSED_ARG(mg);
2227     do_vecset(sv);      /* XXX slurp this routine */
2228     return 0;
2229 }
2230
2231 int
2232 Perl_magic_getdefelem(pTHX_ SV *sv, MAGIC *mg)
2233 {
2234     dVAR;
2235     SV *targ = NULL;
2236
2237     PERL_ARGS_ASSERT_MAGIC_GETDEFELEM;
2238
2239     if (LvTARGLEN(sv)) {
2240         if (mg->mg_obj) {
2241             SV * const ahv = LvTARG(sv);
2242             HE * const he = hv_fetch_ent(MUTABLE_HV(ahv), mg->mg_obj, FALSE, 0);
2243             if (he)
2244                 targ = HeVAL(he);
2245         }
2246         else {
2247             AV *const av = MUTABLE_AV(LvTARG(sv));
2248             if ((I32)LvTARGOFF(sv) <= AvFILL(av))
2249                 targ = AvARRAY(av)[LvTARGOFF(sv)];
2250         }
2251         if (targ && (targ != &PL_sv_undef)) {
2252             /* somebody else defined it for us */
2253             SvREFCNT_dec(LvTARG(sv));
2254             LvTARG(sv) = SvREFCNT_inc_simple_NN(targ);
2255             LvTARGLEN(sv) = 0;
2256             SvREFCNT_dec(mg->mg_obj);
2257             mg->mg_obj = NULL;
2258             mg->mg_flags &= ~MGf_REFCOUNTED;
2259         }
2260     }
2261     else
2262         targ = LvTARG(sv);
2263     sv_setsv(sv, targ ? targ : &PL_sv_undef);
2264     return 0;
2265 }
2266
2267 int
2268 Perl_magic_setdefelem(pTHX_ SV *sv, MAGIC *mg)
2269 {
2270     PERL_ARGS_ASSERT_MAGIC_SETDEFELEM;
2271     PERL_UNUSED_ARG(mg);
2272     if (LvTARGLEN(sv))
2273         vivify_defelem(sv);
2274     if (LvTARG(sv)) {
2275         sv_setsv(LvTARG(sv), sv);
2276         SvSETMAGIC(LvTARG(sv));
2277     }
2278     return 0;
2279 }
2280
2281 void
2282 Perl_vivify_defelem(pTHX_ SV *sv)
2283 {
2284     dVAR;
2285     MAGIC *mg;
2286     SV *value = NULL;
2287
2288     PERL_ARGS_ASSERT_VIVIFY_DEFELEM;
2289
2290     if (!LvTARGLEN(sv) || !(mg = mg_find(sv, PERL_MAGIC_defelem)))
2291         return;
2292     if (mg->mg_obj) {
2293         SV * const ahv = LvTARG(sv);
2294         HE * const he = hv_fetch_ent(MUTABLE_HV(ahv), mg->mg_obj, TRUE, 0);
2295         if (he)
2296             value = HeVAL(he);
2297         if (!value || value == &PL_sv_undef)
2298             Perl_croak(aTHX_ PL_no_helem_sv, SVfARG(mg->mg_obj));
2299     }
2300     else {
2301         AV *const av = MUTABLE_AV(LvTARG(sv));
2302         if ((I32)LvTARGLEN(sv) < 0 && (I32)LvTARGOFF(sv) > AvFILL(av))
2303             LvTARG(sv) = NULL;  /* array can't be extended */
2304         else {
2305             SV* const * const svp = av_fetch(av, LvTARGOFF(sv), TRUE);
2306             if (!svp || (value = *svp) == &PL_sv_undef)
2307                 Perl_croak(aTHX_ PL_no_aelem, (I32)LvTARGOFF(sv));
2308         }
2309     }
2310     SvREFCNT_inc_simple_void(value);
2311     SvREFCNT_dec(LvTARG(sv));
2312     LvTARG(sv) = value;
2313     LvTARGLEN(sv) = 0;
2314     SvREFCNT_dec(mg->mg_obj);
2315     mg->mg_obj = NULL;
2316     mg->mg_flags &= ~MGf_REFCOUNTED;
2317 }
2318
2319 int
2320 Perl_magic_killbackrefs(pTHX_ SV *sv, MAGIC *mg)
2321 {
2322     PERL_ARGS_ASSERT_MAGIC_KILLBACKREFS;
2323     Perl_sv_kill_backrefs(aTHX_ sv, MUTABLE_AV(mg->mg_obj));
2324     return 0;
2325 }
2326
2327 int
2328 Perl_magic_setmglob(pTHX_ SV *sv, MAGIC *mg)
2329 {
2330     PERL_ARGS_ASSERT_MAGIC_SETMGLOB;
2331     PERL_UNUSED_CONTEXT;
2332     mg->mg_len = -1;
2333     if (!isGV_with_GP(sv))
2334         SvSCREAM_off(sv);
2335     return 0;
2336 }
2337
2338 int
2339 Perl_magic_setuvar(pTHX_ SV *sv, MAGIC *mg)
2340 {
2341     const struct ufuncs * const uf = (struct ufuncs *)mg->mg_ptr;
2342
2343     PERL_ARGS_ASSERT_MAGIC_SETUVAR;
2344
2345     if (uf && uf->uf_set)
2346         (*uf->uf_set)(aTHX_ uf->uf_index, sv);
2347     return 0;
2348 }
2349
2350 int
2351 Perl_magic_setregexp(pTHX_ SV *sv, MAGIC *mg)
2352 {
2353     const char type = mg->mg_type;
2354
2355     PERL_ARGS_ASSERT_MAGIC_SETREGEXP;
2356
2357     if (type == PERL_MAGIC_qr) {
2358     } else if (type == PERL_MAGIC_bm) {
2359         SvTAIL_off(sv);
2360         SvVALID_off(sv);
2361     } else {
2362         assert(type == PERL_MAGIC_fm);
2363         SvCOMPILED_off(sv);
2364     }
2365     return sv_unmagic(sv, type);
2366 }
2367
2368 #ifdef USE_LOCALE_COLLATE
2369 int
2370 Perl_magic_setcollxfrm(pTHX_ SV *sv, MAGIC *mg)
2371 {
2372     PERL_ARGS_ASSERT_MAGIC_SETCOLLXFRM;
2373
2374     /*
2375      * RenE<eacute> Descartes said "I think not."
2376      * and vanished with a faint plop.
2377      */
2378     PERL_UNUSED_CONTEXT;
2379     PERL_UNUSED_ARG(sv);
2380     if (mg->mg_ptr) {
2381         Safefree(mg->mg_ptr);
2382         mg->mg_ptr = NULL;
2383         mg->mg_len = -1;
2384     }
2385     return 0;
2386 }
2387 #endif /* USE_LOCALE_COLLATE */
2388
2389 /* Just clear the UTF-8 cache data. */
2390 int
2391 Perl_magic_setutf8(pTHX_ SV *sv, MAGIC *mg)
2392 {
2393     PERL_ARGS_ASSERT_MAGIC_SETUTF8;
2394     PERL_UNUSED_CONTEXT;
2395     PERL_UNUSED_ARG(sv);
2396     Safefree(mg->mg_ptr);       /* The mg_ptr holds the pos cache. */
2397     mg->mg_ptr = NULL;
2398     mg->mg_len = -1;            /* The mg_len holds the len cache. */
2399     return 0;
2400 }
2401
2402 int
2403 Perl_magic_set(pTHX_ SV *sv, MAGIC *mg)
2404 {
2405     dVAR;
2406     register const char *s;
2407     register I32 paren;
2408     register const REGEXP * rx;
2409     const char * const remaining = mg->mg_ptr + 1;
2410     I32 i;
2411     STRLEN len;
2412     MAGIC *tmg;
2413
2414     PERL_ARGS_ASSERT_MAGIC_SET;
2415
2416     switch (*mg->mg_ptr) {
2417     case '\015': /* $^MATCH */
2418       if (strEQ(remaining, "ATCH"))
2419           goto do_match;
2420     case '`': /* ${^PREMATCH} caught below */
2421       do_prematch:
2422       paren = RX_BUFF_IDX_PREMATCH;
2423       goto setparen;
2424     case '\'': /* ${^POSTMATCH} caught below */
2425       do_postmatch:
2426       paren = RX_BUFF_IDX_POSTMATCH;
2427       goto setparen;
2428     case '&':
2429       do_match:
2430       paren = RX_BUFF_IDX_FULLMATCH;
2431       goto setparen;
2432     case '1': case '2': case '3': case '4':
2433     case '5': case '6': case '7': case '8': case '9':
2434       paren = atoi(mg->mg_ptr);
2435       setparen:
2436         if (PL_curpm && (rx = PM_GETRE(PL_curpm))) {
2437             CALLREG_NUMBUF_STORE((REGEXP * const)rx,paren,sv);
2438         } else {
2439             /* Croak with a READONLY error when a numbered match var is
2440              * set without a previous pattern match. Unless it's C<local $1>
2441              */
2442             if (!PL_localizing) {
2443                 Perl_croak_no_modify(aTHX);
2444             }
2445         }
2446         break;
2447     case '\001':        /* ^A */
2448         sv_setsv(PL_bodytarget, sv);
2449         /* mg_set() has temporarily made sv non-magical */
2450         if (PL_tainting) {
2451             if ((tmg = mg_find(sv,PERL_MAGIC_taint)) && tmg->mg_len & 1)
2452                 SvTAINTED_on(PL_bodytarget);
2453             else
2454                 SvTAINTED_off(PL_bodytarget);
2455         }
2456         break;
2457     case '\003':        /* ^C */
2458         PL_minus_c = cBOOL(SvIV(sv));
2459         break;
2460
2461     case '\004':        /* ^D */
2462 #ifdef DEBUGGING
2463         s = SvPV_nolen_const(sv);
2464         PL_debug = get_debug_opts(&s, 0) | DEBUG_TOP_FLAG;
2465         if (DEBUG_x_TEST || DEBUG_B_TEST)
2466             dump_all_perl(!DEBUG_B_TEST);
2467 #else
2468         PL_debug = (SvIV(sv)) | DEBUG_TOP_FLAG;
2469 #endif
2470         break;
2471     case '\005':  /* ^E */
2472         if (*(mg->mg_ptr+1) == '\0') {
2473 #ifdef VMS
2474             set_vaxc_errno(SvIV(sv));
2475 #else
2476 #  ifdef WIN32
2477             SetLastError( SvIV(sv) );
2478 #  else
2479 #    ifdef OS2
2480             os2_setsyserrno(SvIV(sv));
2481 #    else
2482             /* will anyone ever use this? */
2483             SETERRNO(SvIV(sv), 4);
2484 #    endif
2485 #  endif
2486 #endif
2487         }
2488         else if (strEQ(mg->mg_ptr+1, "NCODING")) {
2489             SvREFCNT_dec(PL_encoding);
2490             if (SvOK(sv) || SvGMAGICAL(sv)) {
2491                 PL_encoding = newSVsv(sv);
2492             }
2493             else {
2494                 PL_encoding = NULL;
2495             }
2496         }
2497         break;
2498     case '\006':        /* ^F */
2499         PL_maxsysfd = SvIV(sv);
2500         break;
2501     case '\010':        /* ^H */
2502         PL_hints = SvIV(sv);
2503         break;
2504     case '\011':        /* ^I */ /* NOT \t in EBCDIC */
2505         Safefree(PL_inplace);
2506         PL_inplace = SvOK(sv) ? savesvpv(sv) : NULL;
2507         break;
2508     case '\017':        /* ^O */
2509         if (*(mg->mg_ptr+1) == '\0') {
2510             Safefree(PL_osname);
2511             PL_osname = NULL;
2512             if (SvOK(sv)) {
2513                 TAINT_PROPER("assigning to $^O");
2514                 PL_osname = savesvpv(sv);
2515             }
2516         }
2517         else if (strEQ(mg->mg_ptr, "\017PEN")) {
2518             STRLEN len;
2519             const char *const start = SvPV(sv, len);
2520             const char *out = (const char*)memchr(start, '\0', len);
2521             SV *tmp;
2522
2523
2524             PL_compiling.cop_hints |= HINT_LEXICAL_IO_IN | HINT_LEXICAL_IO_OUT;
2525             PL_hints |= HINT_LEXICAL_IO_IN | HINT_LEXICAL_IO_OUT;
2526
2527             /* Opening for input is more common than opening for output, so
2528                ensure that hints for input are sooner on linked list.  */
2529             tmp = out ? newSVpvn_flags(out + 1, start + len - out - 1,
2530                                        SvUTF8(sv))
2531                 : newSVpvs_flags("", SvUTF8(sv));
2532             (void)hv_stores(GvHV(PL_hintgv), "open>", tmp);
2533             mg_set(tmp);
2534
2535             tmp = newSVpvn_flags(start, out ? (STRLEN)(out - start) : len,
2536                                         SvUTF8(sv));
2537             (void)hv_stores(GvHV(PL_hintgv), "open<", tmp);
2538             mg_set(tmp);
2539         }
2540         break;
2541     case '\020':        /* ^P */
2542       if (*remaining == '\0') { /* ^P */
2543           PL_perldb = SvIV(sv);
2544           if (PL_perldb && !PL_DBsingle)
2545               init_debugger();
2546           break;
2547       } else if (strEQ(remaining, "REMATCH")) { /* $^PREMATCH */
2548           goto do_prematch;
2549       } else if (strEQ(remaining, "OSTMATCH")) { /* $^POSTMATCH */
2550           goto do_postmatch;
2551       }
2552       break;
2553     case '\024':        /* ^T */
2554 #ifdef BIG_TIME
2555         PL_basetime = (Time_t)(SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv));
2556 #else
2557         PL_basetime = (Time_t)SvIV(sv);
2558 #endif
2559         break;
2560     case '\025':        /* ^UTF8CACHE */
2561          if (strEQ(mg->mg_ptr+1, "TF8CACHE")) {
2562              PL_utf8cache = (signed char) sv_2iv(sv);
2563          }
2564          break;
2565     case '\027':        /* ^W & $^WARNING_BITS */
2566         if (*(mg->mg_ptr+1) == '\0') {
2567             if ( ! (PL_dowarn & G_WARN_ALL_MASK)) {
2568                 i = SvIV(sv);
2569                 PL_dowarn = (PL_dowarn & ~G_WARN_ON)
2570                                 | (i ? G_WARN_ON : G_WARN_OFF) ;
2571             }
2572         }
2573         else if (strEQ(mg->mg_ptr+1, "ARNING_BITS")) {
2574             if ( ! (PL_dowarn & G_WARN_ALL_MASK)) {
2575                 if (!SvPOK(sv) && PL_localizing) {
2576                     sv_setpvn(sv, WARN_NONEstring, WARNsize);
2577                     PL_compiling.cop_warnings = pWARN_NONE;
2578                     break;
2579                 }
2580                 {
2581                     STRLEN len, i;
2582                     int accumulate = 0 ;
2583                     int any_fatals = 0 ;
2584                     const char * const ptr = SvPV_const(sv, len) ;
2585                     for (i = 0 ; i < len ; ++i) {
2586                         accumulate |= ptr[i] ;
2587                         any_fatals |= (ptr[i] & 0xAA) ;
2588                     }
2589                     if (!accumulate) {
2590                         if (!specialWARN(PL_compiling.cop_warnings))
2591                             PerlMemShared_free(PL_compiling.cop_warnings);
2592                         PL_compiling.cop_warnings = pWARN_NONE;
2593                     }
2594                     /* Yuck. I can't see how to abstract this:  */
2595                     else if (isWARN_on(((STRLEN *)SvPV_nolen_const(sv)) - 1,
2596                                        WARN_ALL) && !any_fatals) {
2597                         if (!specialWARN(PL_compiling.cop_warnings))
2598                             PerlMemShared_free(PL_compiling.cop_warnings);
2599                         PL_compiling.cop_warnings = pWARN_ALL;
2600                         PL_dowarn |= G_WARN_ONCE ;
2601                     }
2602                     else {
2603                         STRLEN len;
2604                         const char *const p = SvPV_const(sv, len);
2605
2606                         PL_compiling.cop_warnings
2607                             = Perl_new_warnings_bitfield(aTHX_ PL_compiling.cop_warnings,
2608                                                          p, len);
2609
2610                         if (isWARN_on(PL_compiling.cop_warnings, WARN_ONCE))
2611                             PL_dowarn |= G_WARN_ONCE ;
2612                     }
2613
2614                 }
2615             }
2616         }
2617         break;
2618     case '.':
2619         if (PL_localizing) {
2620             if (PL_localizing == 1)
2621                 SAVESPTR(PL_last_in_gv);
2622         }
2623         else if (SvOK(sv) && GvIO(PL_last_in_gv))
2624             IoLINES(GvIOp(PL_last_in_gv)) = SvIV(sv);
2625         break;
2626     case '^':
2627         if (isGV_with_GP(PL_defoutgv)) {
2628             Safefree(IoTOP_NAME(GvIOp(PL_defoutgv)));
2629             s = IoTOP_NAME(GvIOp(PL_defoutgv)) = savesvpv(sv);
2630             IoTOP_GV(GvIOp(PL_defoutgv)) =  gv_fetchsv(sv, GV_ADD, SVt_PVIO);
2631         }
2632         break;
2633     case '~':
2634         if (isGV_with_GP(PL_defoutgv)) {
2635             Safefree(IoFMT_NAME(GvIOp(PL_defoutgv)));
2636             s = IoFMT_NAME(GvIOp(PL_defoutgv)) = savesvpv(sv);
2637             IoFMT_GV(GvIOp(PL_defoutgv)) =  gv_fetchsv(sv, GV_ADD, SVt_PVIO);
2638         }
2639         break;
2640     case '=':
2641         if (isGV_with_GP(PL_defoutgv))
2642             IoPAGE_LEN(GvIOp(PL_defoutgv)) = (SvIV(sv));
2643         break;
2644     case '-':
2645         if (isGV_with_GP(PL_defoutgv)) {
2646             IoLINES_LEFT(GvIOp(PL_defoutgv)) = (SvIV(sv));
2647             if (IoLINES_LEFT(GvIOp(PL_defoutgv)) < 0L)
2648                 IoLINES_LEFT(GvIOp(PL_defoutgv)) = 0L;
2649         }
2650         break;
2651     case '%':
2652         if (isGV_with_GP(PL_defoutgv))
2653             IoPAGE(GvIOp(PL_defoutgv)) = (SvIV(sv));
2654         break;
2655     case '|':
2656         {
2657             IO * const io = GvIO(PL_defoutgv);
2658             if(!io)
2659               break;
2660             if ((SvIV(sv)) == 0)
2661                 IoFLAGS(io) &= ~IOf_FLUSH;
2662             else {
2663                 if (!(IoFLAGS(io) & IOf_FLUSH)) {
2664                     PerlIO *ofp = IoOFP(io);
2665                     if (ofp)
2666                         (void)PerlIO_flush(ofp);
2667                     IoFLAGS(io) |= IOf_FLUSH;
2668                 }
2669             }
2670         }
2671         break;
2672     case '/':
2673         SvREFCNT_dec(PL_rs);
2674         PL_rs = newSVsv(sv);
2675         break;
2676     case '\\':
2677         SvREFCNT_dec(PL_ors_sv);
2678         if (SvOK(sv) || SvGMAGICAL(sv)) {
2679             PL_ors_sv = newSVsv(sv);
2680         }
2681         else {
2682             PL_ors_sv = NULL;
2683         }
2684         break;
2685     case '[':
2686         CopARYBASE_set(&PL_compiling, SvIV(sv));
2687         break;
2688     case '?':
2689 #ifdef COMPLEX_STATUS
2690         if (PL_localizing == 2) {
2691             SvUPGRADE(sv, SVt_PVLV);
2692             PL_statusvalue = LvTARGOFF(sv);
2693             PL_statusvalue_vms = LvTARGLEN(sv);
2694         }
2695         else
2696 #endif
2697 #ifdef VMSISH_STATUS
2698         if (VMSISH_STATUS)
2699             STATUS_NATIVE_CHILD_SET((U32)SvIV(sv));
2700         else
2701 #endif
2702             STATUS_UNIX_EXIT_SET(SvIV(sv));
2703         break;
2704     case '!':
2705         {
2706 #ifdef VMS
2707 #   define PERL_VMS_BANG vaxc$errno
2708 #else
2709 #   define PERL_VMS_BANG 0
2710 #endif
2711         SETERRNO(SvIOK(sv) ? SvIVX(sv) : SvOK(sv) ? sv_2iv(sv) : 0,
2712                  (SvIV(sv) == EVMSERR) ? 4 : PERL_VMS_BANG);
2713         }
2714         break;
2715     case '<':
2716         PL_uid = SvIV(sv);
2717         if (PL_delaymagic) {
2718             PL_delaymagic |= DM_RUID;
2719             break;                              /* don't do magic till later */
2720         }
2721 #ifdef HAS_SETRUID
2722         (void)setruid((Uid_t)PL_uid);
2723 #else
2724 #ifdef HAS_SETREUID
2725         (void)setreuid((Uid_t)PL_uid, (Uid_t)-1);
2726 #else
2727 #ifdef HAS_SETRESUID
2728       (void)setresuid((Uid_t)PL_uid, (Uid_t)-1, (Uid_t)-1);
2729 #else
2730         if (PL_uid == PL_euid) {                /* special case $< = $> */
2731 #ifdef PERL_DARWIN
2732             /* workaround for Darwin's setuid peculiarity, cf [perl #24122] */
2733             if (PL_uid != 0 && PerlProc_getuid() == 0)
2734                 (void)PerlProc_setuid(0);
2735 #endif
2736             (void)PerlProc_setuid(PL_uid);
2737         } else {
2738             PL_uid = PerlProc_getuid();
2739             Perl_croak(aTHX_ "setruid() not implemented");
2740         }
2741 #endif
2742 #endif
2743 #endif
2744         PL_uid = PerlProc_getuid();
2745         break;
2746     case '>':
2747         PL_euid = SvIV(sv);
2748         if (PL_delaymagic) {
2749             PL_delaymagic |= DM_EUID;
2750             break;                              /* don't do magic till later */
2751         }
2752 #ifdef HAS_SETEUID
2753         (void)seteuid((Uid_t)PL_euid);
2754 #else
2755 #ifdef HAS_SETREUID
2756         (void)setreuid((Uid_t)-1, (Uid_t)PL_euid);
2757 #else
2758 #ifdef HAS_SETRESUID
2759         (void)setresuid((Uid_t)-1, (Uid_t)PL_euid, (Uid_t)-1);
2760 #else
2761         if (PL_euid == PL_uid)          /* special case $> = $< */
2762             PerlProc_setuid(PL_euid);
2763         else {
2764             PL_euid = PerlProc_geteuid();
2765             Perl_croak(aTHX_ "seteuid() not implemented");
2766         }
2767 #endif
2768 #endif
2769 #endif
2770         PL_euid = PerlProc_geteuid();
2771         break;
2772     case '(':
2773         PL_gid = SvIV(sv);
2774         if (PL_delaymagic) {
2775             PL_delaymagic |= DM_RGID;
2776             break;                              /* don't do magic till later */
2777         }
2778 #ifdef HAS_SETRGID
2779         (void)setrgid((Gid_t)PL_gid);
2780 #else
2781 #ifdef HAS_SETREGID
2782         (void)setregid((Gid_t)PL_gid, (Gid_t)-1);
2783 #else
2784 #ifdef HAS_SETRESGID
2785       (void)setresgid((Gid_t)PL_gid, (Gid_t)-1, (Gid_t) 1);
2786 #else
2787         if (PL_gid == PL_egid)                  /* special case $( = $) */
2788             (void)PerlProc_setgid(PL_gid);
2789         else {
2790             PL_gid = PerlProc_getgid();
2791             Perl_croak(aTHX_ "setrgid() not implemented");
2792         }
2793 #endif
2794 #endif
2795 #endif
2796         PL_gid = PerlProc_getgid();
2797         break;
2798     case ')':
2799 #ifdef HAS_SETGROUPS
2800         {
2801             const char *p = SvPV_const(sv, len);
2802             Groups_t *gary = NULL;
2803 #ifdef _SC_NGROUPS_MAX
2804            int maxgrp = sysconf(_SC_NGROUPS_MAX);
2805
2806            if (maxgrp < 0)
2807                maxgrp = NGROUPS;
2808 #else
2809            int maxgrp = NGROUPS;
2810 #endif
2811
2812             while (isSPACE(*p))
2813                 ++p;
2814             PL_egid = Atol(p);
2815             for (i = 0; i < maxgrp; ++i) {
2816                 while (*p && !isSPACE(*p))
2817                     ++p;
2818                 while (isSPACE(*p))
2819                     ++p;
2820                 if (!*p)
2821                     break;
2822                 if(!gary)
2823                     Newx(gary, i + 1, Groups_t);
2824                 else
2825                     Renew(gary, i + 1, Groups_t);
2826                 gary[i] = Atol(p);
2827             }
2828             if (i)
2829                 (void)setgroups(i, gary);
2830             Safefree(gary);
2831         }
2832 #else  /* HAS_SETGROUPS */
2833         PL_egid = SvIV(sv);
2834 #endif /* HAS_SETGROUPS */
2835         if (PL_delaymagic) {
2836             PL_delaymagic |= DM_EGID;
2837             break;                              /* don't do magic till later */
2838         }
2839 #ifdef HAS_SETEGID
2840         (void)setegid((Gid_t)PL_egid);
2841 #else
2842 #ifdef HAS_SETREGID
2843         (void)setregid((Gid_t)-1, (Gid_t)PL_egid);
2844 #else
2845 #ifdef HAS_SETRESGID
2846         (void)setresgid((Gid_t)-1, (Gid_t)PL_egid, (Gid_t)-1);
2847 #else
2848         if (PL_egid == PL_gid)                  /* special case $) = $( */
2849             (void)PerlProc_setgid(PL_egid);
2850         else {
2851             PL_egid = PerlProc_getegid();
2852             Perl_croak(aTHX_ "setegid() not implemented");
2853         }
2854 #endif
2855 #endif
2856 #endif
2857         PL_egid = PerlProc_getegid();
2858         break;
2859     case ':':
2860         PL_chopset = SvPV_force(sv,len);
2861         break;
2862     case '0':
2863         LOCK_DOLLARZERO_MUTEX;
2864 #ifdef HAS_SETPROCTITLE
2865         /* The BSDs don't show the argv[] in ps(1) output, they
2866          * show a string from the process struct and provide
2867          * the setproctitle() routine to manipulate that. */
2868         if (PL_origalen != 1) {
2869             s = SvPV_const(sv, len);
2870 #   if __FreeBSD_version > 410001
2871             /* The leading "-" removes the "perl: " prefix,
2872              * but not the "(perl) suffix from the ps(1)
2873              * output, because that's what ps(1) shows if the
2874              * argv[] is modified. */
2875             setproctitle("-%s", s);
2876 #   else        /* old FreeBSDs, NetBSD, OpenBSD, anyBSD */
2877             /* This doesn't really work if you assume that
2878              * $0 = 'foobar'; will wipe out 'perl' from the $0
2879              * because in ps(1) output the result will be like
2880              * sprintf("perl: %s (perl)", s)
2881              * I guess this is a security feature:
2882              * one (a user process) cannot get rid of the original name.
2883              * --jhi */
2884             setproctitle("%s", s);
2885 #   endif
2886         }
2887 #elif defined(__hpux) && defined(PSTAT_SETCMD)
2888         if (PL_origalen != 1) {
2889              union pstun un;
2890              s = SvPV_const(sv, len);
2891              un.pst_command = (char *)s;
2892              pstat(PSTAT_SETCMD, un, len, 0, 0);
2893         }
2894 #else
2895         if (PL_origalen > 1) {
2896             /* PL_origalen is set in perl_parse(). */
2897             s = SvPV_force(sv,len);
2898             if (len >= (STRLEN)PL_origalen-1) {
2899                 /* Longer than original, will be truncated. We assume that
2900                  * PL_origalen bytes are available. */
2901                 Copy(s, PL_origargv[0], PL_origalen-1, char);
2902             }
2903             else {
2904                 /* Shorter than original, will be padded. */
2905 #ifdef PERL_DARWIN
2906                 /* Special case for Mac OS X: see [perl #38868] */
2907                 const int pad = 0;
2908 #else
2909                 /* Is the space counterintuitive?  Yes.
2910                  * (You were expecting \0?)
2911                  * Does it work?  Seems to.  (In Linux 2.4.20 at least.)
2912                  * --jhi */
2913                 const int pad = ' ';
2914 #endif
2915                 Copy(s, PL_origargv[0], len, char);
2916                 PL_origargv[0][len] = 0;
2917                 memset(PL_origargv[0] + len + 1,
2918                        pad,  PL_origalen - len - 1);
2919             }
2920             PL_origargv[0][PL_origalen-1] = 0;
2921             for (i = 1; i < PL_origargc; i++)
2922                 PL_origargv[i] = 0;
2923 #ifdef HAS_PRCTL_SET_NAME
2924             /* Set the legacy process name in addition to the POSIX name on Linux */
2925             if (prctl(PR_SET_NAME, (unsigned long)s, 0, 0, 0) != 0) {
2926                 /* diag_listed_as: SKIPME */
2927                 Perl_croak(aTHX_ "Can't set $0 with prctl(): %s", Strerror(errno));
2928             }
2929 #endif
2930         }
2931 #endif
2932         UNLOCK_DOLLARZERO_MUTEX;
2933         break;
2934     }
2935     return 0;
2936 }
2937
2938 I32
2939 Perl_whichsig(pTHX_ const char *sig)
2940 {
2941     register char* const* sigv;
2942
2943     PERL_ARGS_ASSERT_WHICHSIG;
2944     PERL_UNUSED_CONTEXT;
2945
2946     for (sigv = (char* const*)PL_sig_name; *sigv; sigv++)
2947         if (strEQ(sig,*sigv))
2948             return PL_sig_num[sigv - (char* const*)PL_sig_name];
2949 #ifdef SIGCLD
2950     if (strEQ(sig,"CHLD"))
2951         return SIGCLD;
2952 #endif
2953 #ifdef SIGCHLD
2954     if (strEQ(sig,"CLD"))
2955         return SIGCHLD;
2956 #endif
2957     return -1;
2958 }
2959
2960 Signal_t
2961 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
2962 Perl_sighandler(int sig, siginfo_t *sip, void *uap PERL_UNUSED_DECL)
2963 #else
2964 Perl_sighandler(int sig)
2965 #endif
2966 {
2967 #ifdef PERL_GET_SIG_CONTEXT
2968     dTHXa(PERL_GET_SIG_CONTEXT);
2969 #else
2970     dTHX;
2971 #endif
2972     dSP;
2973     GV *gv = NULL;
2974     SV *sv = NULL;
2975     SV * const tSv = PL_Sv;
2976     CV *cv = NULL;
2977     OP *myop = PL_op;
2978     U32 flags = 0;
2979     XPV * const tXpv = PL_Xpv;
2980     I32 old_ss_ix = PL_savestack_ix;
2981
2982
2983     if (!PL_psig_ptr[sig]) {
2984                 PerlIO_printf(Perl_error_log, "Signal SIG%s received, but no signal handler set.\n",
2985                                  PL_sig_name[sig]);
2986                 exit(sig);
2987         }
2988
2989     /* Max number of items pushed there is 3*n or 4. We cannot fix
2990        infinity, so we fix 4 (in fact 5): */
2991     if (PL_savestack_ix + 15 <= PL_savestack_max) {
2992         flags |= 1;
2993         PL_savestack_ix += 5;           /* Protect save in progress. */
2994         SAVEDESTRUCTOR_X(S_unwind_handler_stack, NULL);
2995     }
2996     if (PL_markstack_ptr < PL_markstack_max - 2) {
2997         flags |= 2;
2998         PL_markstack_ptr++;             /* Protect mark. */
2999     }
3000     if (PL_scopestack_ix < PL_scopestack_max - 3) {
3001         flags |= 4;
3002         PL_scopestack_ix++;
3003     }
3004     /* sv_2cv is too complicated, try a simpler variant first: */
3005     if (!SvROK(PL_psig_ptr[sig]) || !(cv = MUTABLE_CV(SvRV(PL_psig_ptr[sig])))
3006         || SvTYPE(cv) != SVt_PVCV) {
3007         HV *st;
3008         cv = sv_2cv(PL_psig_ptr[sig], &st, &gv, GV_ADD);
3009     }
3010
3011     if (!cv || !CvROOT(cv)) {
3012         Perl_ck_warner(aTHX_ packWARN(WARN_SIGNAL), "SIG%s handler \"%s\" not defined.\n",
3013                        PL_sig_name[sig], (gv ? GvENAME(gv)
3014                                           : ((cv && CvGV(cv))
3015                                              ? GvENAME(CvGV(cv))
3016                                              : "__ANON__")));
3017         goto cleanup;
3018     }
3019
3020     sv = PL_psig_name[sig]
3021             ? SvREFCNT_inc_NN(PL_psig_name[sig])
3022             : newSVpv(PL_sig_name[sig],0);
3023     flags |= 8;
3024     SAVEFREESV(sv);
3025
3026     /* make sure our assumption about the size of the SAVEs are correct:
3027      * 3 for SAVEDESTRUCTOR_X, 2 for SAVEFREESV */
3028     assert(old_ss_ix + 2 + ((flags & 1) ? 3+5 : 0)  == PL_savestack_ix);
3029
3030     PUSHSTACKi(PERLSI_SIGNAL);
3031     PUSHMARK(SP);
3032     PUSHs(sv);
3033 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
3034     {
3035          struct sigaction oact;
3036
3037          if (sigaction(sig, 0, &oact) == 0 && oact.sa_flags & SA_SIGINFO) {
3038               if (sip) {
3039                    HV *sih = newHV();
3040                    SV *rv  = newRV_noinc(MUTABLE_SV(sih));
3041                    /* The siginfo fields signo, code, errno, pid, uid,
3042                     * addr, status, and band are defined by POSIX/SUSv3. */
3043                    (void)hv_stores(sih, "signo", newSViv(sip->si_signo));
3044                    (void)hv_stores(sih, "code", newSViv(sip->si_code));
3045 #if 0 /* XXX TODO: Configure scan for the existence of these, but even that does not help if the SA_SIGINFO is not implemented according to the spec. */
3046                    hv_stores(sih, "errno",      newSViv(sip->si_errno));
3047                    hv_stores(sih, "status",     newSViv(sip->si_status));
3048                    hv_stores(sih, "uid",        newSViv(sip->si_uid));
3049                    hv_stores(sih, "pid",        newSViv(sip->si_pid));
3050                    hv_stores(sih, "addr",       newSVuv(PTR2UV(sip->si_addr)));
3051                    hv_stores(sih, "band",       newSViv(sip->si_band));
3052 #endif
3053                    EXTEND(SP, 2);
3054                    PUSHs(rv);
3055                    mPUSHp((char *)sip, sizeof(*sip));
3056               }
3057
3058          }
3059     }
3060 #endif
3061     PUTBACK;
3062
3063     call_sv(MUTABLE_SV(cv), G_DISCARD|G_EVAL);
3064
3065     POPSTACK;
3066     if (SvTRUE(ERRSV)) {
3067 #ifndef PERL_MICRO
3068 #ifdef HAS_SIGPROCMASK
3069         /* Handler "died", for example to get out of a restart-able read().
3070          * Before we re-do that on its behalf re-enable the signal which was
3071          * blocked by the system when we entered.
3072          */
3073         sigset_t set;
3074         sigemptyset(&set);
3075         sigaddset(&set,sig);
3076         sigprocmask(SIG_UNBLOCK, &set, NULL);
3077 #else
3078         /* Not clear if this will work */
3079         (void)rsignal(sig, SIG_IGN);
3080         (void)rsignal(sig, PL_csighandlerp);
3081 #endif
3082 #endif /* !PERL_MICRO */
3083         die_sv(ERRSV);
3084     }
3085 cleanup:
3086     /* pop any of SAVEFREESV, SAVEDESTRUCTOR_X and "save in progress" */
3087     PL_savestack_ix = old_ss_ix;
3088     if (flags & 2)
3089         PL_markstack_ptr--;
3090     if (flags & 4)
3091         PL_scopestack_ix -= 1;
3092     if (flags & 8)
3093         SvREFCNT_dec(sv);
3094     PL_op = myop;                       /* Apparently not needed... */
3095
3096     PL_Sv = tSv;                        /* Restore global temporaries. */
3097     PL_Xpv = tXpv;
3098     return;
3099 }
3100
3101
3102 static void
3103 S_restore_magic(pTHX_ const void *p)
3104 {
3105     dVAR;
3106     MGS* const mgs = SSPTR(PTR2IV(p), MGS*);
3107     SV* const sv = mgs->mgs_sv;
3108
3109     if (!sv)
3110         return;
3111
3112     if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv))
3113     {
3114 #ifdef PERL_OLD_COPY_ON_WRITE
3115         /* While magic was saved (and off) sv_setsv may well have seen
3116            this SV as a prime candidate for COW.  */
3117         if (SvIsCOW(sv))
3118             sv_force_normal_flags(sv, 0);
3119 #endif
3120
3121         if (mgs->mgs_readonly)
3122             SvREADONLY_on(sv);
3123         if (mgs->mgs_magical)
3124             SvFLAGS(sv) |= mgs->mgs_magical;
3125         else
3126             mg_magical(sv);
3127         if (SvGMAGICAL(sv)) {
3128             /* downgrade public flags to private,
3129                and discard any other private flags */
3130
3131             const U32 pubflags = SvFLAGS(sv) & (SVf_IOK|SVf_NOK|SVf_POK);
3132             if (pubflags) {
3133                 SvFLAGS(sv) &= ~( pubflags | (SVp_IOK|SVp_NOK|SVp_POK) );
3134                 SvFLAGS(sv) |= ( pubflags << PRIVSHIFT );
3135             }
3136         }
3137     }
3138
3139     mgs->mgs_sv = NULL;  /* mark the MGS structure as restored */
3140
3141     /* If we're still on top of the stack, pop us off.  (That condition
3142      * will be satisfied if restore_magic was called explicitly, but *not*
3143      * if it's being called via leave_scope.)
3144      * The reason for doing this is that otherwise, things like sv_2cv()
3145      * may leave alloc gunk on the savestack, and some code
3146      * (e.g. sighandler) doesn't expect that...
3147      */
3148     if (PL_savestack_ix == mgs->mgs_ss_ix)
3149     {
3150         UV popval = SSPOPUV;
3151         assert(popval == SAVEt_DESTRUCTOR_X);
3152         PL_savestack_ix -= 2;
3153         popval = SSPOPUV;
3154         assert((popval & SAVE_MASK) == SAVEt_ALLOC);
3155         PL_savestack_ix -= popval >> SAVE_TIGHT_SHIFT;
3156     }
3157     if (SvREFCNT(sv) == 1) {
3158         /* We hold the last reference to this SV, which implies that the
3159            SV was deleted as a side effect of the routines we called.
3160            So artificially keep it alive a bit longer.
3161            We avoid turning on the TEMP flag, which can cause the SV's
3162            buffer to get stolen (and maybe other stuff). */
3163         int was_temp = SvTEMP(sv);
3164         sv_2mortal(sv);
3165         if (!was_temp) {
3166             SvTEMP_off(sv);
3167         }
3168         SvOK_off(sv);
3169     }
3170     else
3171         SvREFCNT_dec(sv); /* undo the inc in S_save_magic() */
3172 }
3173
3174 /* clean up the mess created by Perl_sighandler().
3175  * Note that this is only called during an exit in a signal handler;
3176  * a die is trapped by the call_sv() and the SAVEDESTRUCTOR_X manually
3177  * skipped over. This is why we don't need to fix up the markstack and
3178  * scopestack - they're going to be set to 0 anyway */
3179
3180 static void
3181 S_unwind_handler_stack(pTHX_ const void *p)
3182 {
3183     dVAR;
3184     PERL_UNUSED_ARG(p);
3185
3186     PL_savestack_ix -= 5; /* Unprotect save in progress. */
3187 }
3188
3189 /*
3190 =for apidoc magic_sethint
3191
3192 Triggered by a store to %^H, records the key/value pair to
3193 C<PL_compiling.cop_hints_hash>.  It is assumed that hints aren't storing
3194 anything that would need a deep copy.  Maybe we should warn if we find a
3195 reference.
3196
3197 =cut
3198 */
3199 int
3200 Perl_magic_sethint(pTHX_ SV *sv, MAGIC *mg)
3201 {
3202     dVAR;
3203     SV *key = (mg->mg_len == HEf_SVKEY) ? MUTABLE_SV(mg->mg_ptr)
3204         : newSVpvn_flags(mg->mg_ptr, mg->mg_len, SVs_TEMP);
3205
3206     PERL_ARGS_ASSERT_MAGIC_SETHINT;
3207
3208     /* mg->mg_obj isn't being used.  If needed, it would be possible to store
3209        an alternative leaf in there, with PL_compiling.cop_hints being used if
3210        it's NULL. If needed for threads, the alternative could lock a mutex,
3211        or take other more complex action.  */
3212
3213     /* Something changed in %^H, so it will need to be restored on scope exit.
3214        Doing this here saves a lot of doing it manually in perl code (and
3215        forgetting to do it, and consequent subtle errors.  */
3216     PL_hints |= HINT_LOCALIZE_HH;
3217     CopHINTHASH_set(&PL_compiling,
3218         cophh_store_sv(CopHINTHASH_get(&PL_compiling), key, 0, sv, 0));
3219     return 0;
3220 }
3221
3222 /*
3223 =for apidoc magic_clearhint
3224
3225 Triggered by a delete from %^H, records the key to
3226 C<PL_compiling.cop_hints_hash>.
3227
3228 =cut
3229 */
3230 int
3231 Perl_magic_clearhint(pTHX_ SV *sv, MAGIC *mg)
3232 {
3233     dVAR;
3234
3235     PERL_ARGS_ASSERT_MAGIC_CLEARHINT;
3236     PERL_UNUSED_ARG(sv);
3237
3238     assert(mg->mg_len == HEf_SVKEY);
3239
3240     PERL_UNUSED_ARG(sv);
3241
3242     PL_hints |= HINT_LOCALIZE_HH;
3243     CopHINTHASH_set(&PL_compiling,
3244         cophh_delete_sv(CopHINTHASH_get(&PL_compiling),
3245                                  MUTABLE_SV(mg->mg_ptr), 0, 0));
3246     return 0;
3247 }
3248
3249 /*
3250 =for apidoc magic_clearhints
3251
3252 Triggered by clearing %^H, resets C<PL_compiling.cop_hints_hash>.
3253
3254 =cut
3255 */
3256 int
3257 Perl_magic_clearhints(pTHX_ SV *sv, MAGIC *mg)
3258 {
3259     PERL_ARGS_ASSERT_MAGIC_CLEARHINTS;
3260     PERL_UNUSED_ARG(sv);
3261     PERL_UNUSED_ARG(mg);
3262     cophh_free(CopHINTHASH_get(&PL_compiling));
3263     CopHINTHASH_set(&PL_compiling, cophh_new_empty());
3264     return 0;
3265 }
3266
3267 /*
3268  * Local variables:
3269  * c-indentation-style: bsd
3270  * c-basic-offset: 4
3271  * indent-tabs-mode: t
3272  * End:
3273  *
3274  * ex: set ts=8 sts=4 sw=4 noet:
3275  */