util.c

   1 /*    util.c
   2  *
   3  *    Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
   4  *    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  * 'Very useful, no doubt, that was to Saruman; yet it seems that he was
  13  *  not content.'                                    --Gandalf to Pippin
  14  *
  15  *     [p.598 of _The Lord of the Rings_, III/xi: "The Palantír"]
  16  */
  17
  18 /* This file contains assorted utility routines.
  19  * Which is a polite way of saying any stuff that people couldn't think of
  20  * a better place for. Amongst other things, it includes the warning and
  21  * dieing stuff, plus wrappers for malloc code.
  22  */
  23
  24 #include "EXTERN.h"
  25 #define PERL_IN_UTIL_C
  26 #include "perl.h"
  27 #include "reentr.h"
  28
  29 #if defined(USE_PERLIO)
  30 #include "perliol.h" /* For PerlIOUnix_refcnt */
  31 #endif
  32
  33 #ifndef PERL_MICRO
  34 #include <signal.h>
  35 #ifndef SIG_ERR
  36 # define SIG_ERR ((Sighandler_t) -1)
  37 #endif
  38 #endif
  39
  40 #include <math.h>
  41 #include <stdlib.h>
  42
  43 #ifdef __Lynx__
  44 /* Missing protos on LynxOS */
  45 int putenv(char *);
  46 #endif
  47
  48 #ifdef __amigaos__
  49 # include "amigaos4/amigaio.h"
  50 #endif
  51
  52 #ifdef HAS_SELECT
  53 # ifdef I_SYS_SELECT
  54 #  include <sys/select.h>
  55 # endif
  56 #endif
  57
  58 #ifdef USE_C_BACKTRACE
  59 #  ifdef I_BFD
  60 #    define USE_BFD
  61 #    ifdef PERL_DARWIN
  62 #      undef USE_BFD /* BFD is useless in OS X. */
  63 #    endif
  64 #    ifdef USE_BFD
  65 #      include <bfd.h>
  66 #    endif
  67 #  endif
  68 #  ifdef I_DLFCN
  69 #    include <dlfcn.h>
  70 #  endif
  71 #  ifdef I_EXECINFO
  72 #    include <execinfo.h>
  73 #  endif
  74 #endif
  75
  76 #ifdef PERL_DEBUG_READONLY_COW
  77 # include <sys/mman.h>
  78 #endif
  79
  80 #define FLUSH
  81
  82 /* NOTE:  Do not call the next three routines directly.  Use the macros
  83  * in handy.h, so that we can easily redefine everything to do tracking of
  84  * allocated hunks back to the original New to track down any memory leaks.
  85  * XXX This advice seems to be widely ignored :-(   --AD  August 1996.
  86  */
  87
  88 #if defined (DEBUGGING) || defined(PERL_IMPLICIT_SYS) || defined (PERL_TRACK_MEMPOOL)
  89 #  define ALWAYS_NEED_THX
  90 #endif
  91
  92 #if defined(PERL_TRACK_MEMPOOL) && defined(PERL_DEBUG_READONLY_COW)
  93 static void
  94 S_maybe_protect_rw(pTHX_ struct perl_memory_debug_header *header)
  95 {
  96     if (header->readonly
  97      && mprotect(header, header->size, PROT_READ|PROT_WRITE))
  98         Perl_warn(aTHX_ "mprotect for COW string %p %lu failed with %d",
  99                          header, header->size, errno);
 100 }
 101
 102 static void
 103 S_maybe_protect_ro(pTHX_ struct perl_memory_debug_header *header)
 104 {
 105     if (header->readonly
 106      && mprotect(header, header->size, PROT_READ))
 107         Perl_warn(aTHX_ "mprotect RW for COW string %p %lu failed with %d",
 108                          header, header->size, errno);
 109 }
 110 # define maybe_protect_rw(foo) S_maybe_protect_rw(aTHX_ foo)
 111 # define maybe_protect_ro(foo) S_maybe_protect_ro(aTHX_ foo)
 112 #else
 113 # define maybe_protect_rw(foo) NOOP
 114 # define maybe_protect_ro(foo) NOOP
 115 #endif
 116
 117 #if defined(PERL_TRACK_MEMPOOL) || defined(PERL_DEBUG_READONLY_COW)
 118  /* Use memory_debug_header */
 119 # define USE_MDH
 120 # if (defined(PERL_POISON) && defined(PERL_TRACK_MEMPOOL)) \
 121    || defined(PERL_DEBUG_READONLY_COW)
 122 #  define MDH_HAS_SIZE
 123 # endif
 124 #endif
 125
 126 /* paranoid version of system's malloc() */
 127
 128 Malloc_t
 129 Perl_safesysmalloc(MEM_SIZE size)
 130 {
 131 #ifdef ALWAYS_NEED_THX
 132     dTHX;
 133 #endif
 134     Malloc_t ptr;
 135
 136 #ifdef USE_MDH
 137     if (size + PERL_MEMORY_DEBUG_HEADER_SIZE < size)
 138         goto out_of_memory;
 139     size += PERL_MEMORY_DEBUG_HEADER_SIZE;
 140 #endif
 141 #ifdef DEBUGGING
 142     if ((SSize_t)size < 0)
 143         Perl_croak_nocontext("panic: malloc, size=%" UVuf, (UV) size);
 144 #endif
 145     if (!size) size = 1;        /* malloc(0) is NASTY on our system */
 146 #ifdef PERL_DEBUG_READONLY_COW
 147     if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
 148                     MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
 149         perror("mmap failed");
 150         abort();
 151     }
 152 #else
 153     ptr = (Malloc_t)PerlMem_malloc(size?size:1);
 154 #endif
 155     PERL_ALLOC_CHECK(ptr);
 156     if (ptr != NULL) {
 157 #ifdef USE_MDH
 158         struct perl_memory_debug_header *const header
 159             = (struct perl_memory_debug_header *)ptr;
 160 #endif
 161
 162 #ifdef PERL_POISON
 163         PoisonNew(((char *)ptr), size, char);
 164 #endif
 165
 166 #ifdef PERL_TRACK_MEMPOOL
 167         header->interpreter = aTHX;
 168         /* Link us into the list.  */
 169         header->prev = &PL_memory_debug_header;
 170         header->next = PL_memory_debug_header.next;
 171         PL_memory_debug_header.next = header;
 172         maybe_protect_rw(header->next);
 173         header->next->prev = header;
 174         maybe_protect_ro(header->next);
 175 #  ifdef PERL_DEBUG_READONLY_COW
 176         header->readonly = 0;
 177 #  endif
 178 #endif
 179 #ifdef MDH_HAS_SIZE
 180         header->size = size;
 181 #endif
 182         ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
 183         DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) malloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
 184
 185     }
 186     else {
 187 #ifdef USE_MDH
 188       out_of_memory:
 189 #endif
 190         {
 191 #ifndef ALWAYS_NEED_THX
 192             dTHX;
 193 #endif
 194             if (PL_nomemok)
 195                 ptr =  NULL;
 196             else
 197                 croak_no_mem();
 198         }
 199     }
 200     return ptr;
 201 }
 202
 203 /* paranoid version of system's realloc() */
 204
 205 Malloc_t
 206 Perl_safesysrealloc(Malloc_t where,MEM_SIZE size)
 207 {
 208 #ifdef ALWAYS_NEED_THX
 209     dTHX;
 210 #endif
 211     Malloc_t ptr;
 212 #ifdef PERL_DEBUG_READONLY_COW
 213     const MEM_SIZE oldsize = where
 214         ? ((struct perl_memory_debug_header *)((char *)where - PERL_MEMORY_DEBUG_HEADER_SIZE))->size
 215         : 0;
 216 #endif
 217 #if !defined(STANDARD_C) && !defined(HAS_REALLOC_PROTOTYPE) && !defined(PERL_MICRO)
 218     Malloc_t PerlMem_realloc();
 219 #endif /* !defined(STANDARD_C) && !defined(HAS_REALLOC_PROTOTYPE) */
 220
 221     if (!size) {
 222         safesysfree(where);
 223         ptr = NULL;
 224     }
 225     else if (!where) {
 226         ptr = safesysmalloc(size);
 227     }
 228     else {
 229 #ifdef USE_MDH
 230         where = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
 231         if (size + PERL_MEMORY_DEBUG_HEADER_SIZE < size)
 232             goto out_of_memory;
 233         size += PERL_MEMORY_DEBUG_HEADER_SIZE;
 234         {
 235             struct perl_memory_debug_header *const header
 236                 = (struct perl_memory_debug_header *)where;
 237
 238 # ifdef PERL_TRACK_MEMPOOL
 239             if (header->interpreter != aTHX) {
 240                 Perl_croak_nocontext("panic: realloc from wrong pool, %p!=%p",
 241                                      header->interpreter, aTHX);
 242             }
 243             assert(header->next->prev == header);
 244             assert(header->prev->next == header);
 245 #  ifdef PERL_POISON
 246             if (header->size > size) {
 247                 const MEM_SIZE freed_up = header->size - size;
 248                 char *start_of_freed = ((char *)where) + size;
 249                 PoisonFree(start_of_freed, freed_up, char);
 250             }
 251 #  endif
 252 # endif
 253 # ifdef MDH_HAS_SIZE
 254             header->size = size;
 255 # endif
 256         }
 257 #endif
 258 #ifdef DEBUGGING
 259         if ((SSize_t)size < 0)
 260             Perl_croak_nocontext("panic: realloc, size=%" UVuf, (UV)size);
 261 #endif
 262 #ifdef PERL_DEBUG_READONLY_COW
 263         if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
 264                         MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
 265             perror("mmap failed");
 266             abort();
 267         }
 268         Copy(where,ptr,oldsize < size ? oldsize : size,char);
 269         if (munmap(where, oldsize)) {
 270             perror("munmap failed");
 271             abort();
 272         }
 273 #else
 274         ptr = (Malloc_t)PerlMem_realloc(where,size);
 275 #endif
 276         PERL_ALLOC_CHECK(ptr);
 277
 278     /* MUST do this fixup first, before doing ANYTHING else, as anything else
 279        might allocate memory/free/move memory, and until we do the fixup, it
 280        may well be chasing (and writing to) free memory.  */
 281         if (ptr != NULL) {
 282 #ifdef PERL_TRACK_MEMPOOL
 283             struct perl_memory_debug_header *const header
 284                 = (struct perl_memory_debug_header *)ptr;
 285
 286 #  ifdef PERL_POISON
 287             if (header->size < size) {
 288                 const MEM_SIZE fresh = size - header->size;
 289                 char *start_of_fresh = ((char *)ptr) + size;
 290                 PoisonNew(start_of_fresh, fresh, char);
 291             }
 292 #  endif
 293
 294             maybe_protect_rw(header->next);
 295             header->next->prev = header;
 296             maybe_protect_ro(header->next);
 297             maybe_protect_rw(header->prev);
 298             header->prev->next = header;
 299             maybe_protect_ro(header->prev);
 300 #endif
 301             ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
 302         }
 303
 304     /* In particular, must do that fixup above before logging anything via
 305      *printf(), as it can reallocate memory, which can cause SEGVs.  */
 306
 307         DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) rfree\n",PTR2UV(where),(long)PL_an++));
 308         DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) realloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
 309
 310         if (ptr == NULL) {
 311 #ifdef USE_MDH
 312           out_of_memory:
 313 #endif
 314             {
 315 #ifndef ALWAYS_NEED_THX
 316                 dTHX;
 317 #endif
 318                 if (PL_nomemok)
 319                     ptr = NULL;
 320                 else
 321                     croak_no_mem();
 322             }
 323         }
 324     }
 325     return ptr;
 326 }
 327
 328 /* safe version of system's free() */
 329
 330 Free_t
 331 Perl_safesysfree(Malloc_t where)
 332 {
 333 #ifdef ALWAYS_NEED_THX
 334     dTHX;
 335 #endif
 336     DEBUG_m( PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) free\n",PTR2UV(where),(long)PL_an++));
 337     if (where) {
 338 #ifdef USE_MDH
 339         Malloc_t where_intrn = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
 340         {
 341             struct perl_memory_debug_header *const header
 342                 = (struct perl_memory_debug_header *)where_intrn;
 343
 344 # ifdef MDH_HAS_SIZE
 345             const MEM_SIZE size = header->size;
 346 # endif
 347 # ifdef PERL_TRACK_MEMPOOL
 348             if (header->interpreter != aTHX) {
 349                 Perl_croak_nocontext("panic: free from wrong pool, %p!=%p",
 350                                      header->interpreter, aTHX);
 351             }
 352             if (!header->prev) {
 353                 Perl_croak_nocontext("panic: duplicate free");
 354             }
 355             if (!(header->next))
 356                 Perl_croak_nocontext("panic: bad free, header->next==NULL");
 357             if (header->next->prev != header || header->prev->next != header) {
 358                 Perl_croak_nocontext("panic: bad free, ->next->prev=%p, "
 359                                      "header=%p, ->prev->next=%p",
 360                                      header->next->prev, header,
 361                                      header->prev->next);
 362             }
 363             /* Unlink us from the chain.  */
 364             maybe_protect_rw(header->next);
 365             header->next->prev = header->prev;
 366             maybe_protect_ro(header->next);
 367             maybe_protect_rw(header->prev);
 368             header->prev->next = header->next;
 369             maybe_protect_ro(header->prev);
 370             maybe_protect_rw(header);
 371 #  ifdef PERL_POISON
 372             PoisonNew(where_intrn, size, char);
 373 #  endif
 374             /* Trigger the duplicate free warning.  */
 375             header->next = NULL;
 376 # endif
 377 # ifdef PERL_DEBUG_READONLY_COW
 378             if (munmap(where_intrn, size)) {
 379                 perror("munmap failed");
 380                 abort();
 381             }
 382 # endif
 383         }
 384 #else
 385         Malloc_t where_intrn = where;
 386 #endif /* USE_MDH */
 387 #ifndef PERL_DEBUG_READONLY_COW
 388         PerlMem_free(where_intrn);
 389 #endif
 390     }
 391 }
 392
 393 /* safe version of system's calloc() */
 394
 395 Malloc_t
 396 Perl_safesyscalloc(MEM_SIZE count, MEM_SIZE size)
 397 {
 398 #ifdef ALWAYS_NEED_THX
 399     dTHX;
 400 #endif
 401     Malloc_t ptr;
 402 #if defined(USE_MDH) || defined(DEBUGGING)
 403     MEM_SIZE total_size = 0;
 404 #endif
 405
 406     /* Even though calloc() for zero bytes is strange, be robust. */
 407     if (size && (count <= MEM_SIZE_MAX / size)) {
 408 #if defined(USE_MDH) || defined(DEBUGGING)
 409         total_size = size * count;
 410 #endif
 411     }
 412     else
 413         croak_memory_wrap();
 414 #ifdef USE_MDH
 415     if (PERL_MEMORY_DEBUG_HEADER_SIZE <= MEM_SIZE_MAX - (MEM_SIZE)total_size)
 416         total_size += PERL_MEMORY_DEBUG_HEADER_SIZE;
 417     else
 418         croak_memory_wrap();
 419 #endif
 420 #ifdef DEBUGGING
 421     if ((SSize_t)size < 0 || (SSize_t)count < 0)
 422         Perl_croak_nocontext("panic: calloc, size=%" UVuf ", count=%" UVuf,
 423                              (UV)size, (UV)count);
 424 #endif
 425 #ifdef PERL_DEBUG_READONLY_COW
 426     if ((ptr = mmap(0, total_size ? total_size : 1, PROT_READ|PROT_WRITE,
 427                     MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
 428         perror("mmap failed");
 429         abort();
 430     }
 431 #elif defined(PERL_TRACK_MEMPOOL)
 432     /* Have to use malloc() because we've added some space for our tracking
 433        header.  */
 434     /* malloc(0) is non-portable. */
 435     ptr = (Malloc_t)PerlMem_malloc(total_size ? total_size : 1);
 436 #else
 437     /* Use calloc() because it might save a memset() if the memory is fresh
 438        and clean from the OS.  */
 439     if (count && size)
 440         ptr = (Malloc_t)PerlMem_calloc(count, size);
 441     else /* calloc(0) is non-portable. */
 442         ptr = (Malloc_t)PerlMem_calloc(count ? count : 1, size ? size : 1);
 443 #endif
 444     PERL_ALLOC_CHECK(ptr);
 445     DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) calloc %ld x %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)count,(long)total_size));
 446     if (ptr != NULL) {
 447 #ifdef USE_MDH
 448         {
 449             struct perl_memory_debug_header *const header
 450                 = (struct perl_memory_debug_header *)ptr;
 451
 452 #  ifndef PERL_DEBUG_READONLY_COW
 453             memset((void*)ptr, 0, total_size);
 454 #  endif
 455 #  ifdef PERL_TRACK_MEMPOOL
 456             header->interpreter = aTHX;
 457             /* Link us into the list.  */
 458             header->prev = &PL_memory_debug_header;
 459             header->next = PL_memory_debug_header.next;
 460             PL_memory_debug_header.next = header;
 461             maybe_protect_rw(header->next);
 462             header->next->prev = header;
 463             maybe_protect_ro(header->next);
 464 #    ifdef PERL_DEBUG_READONLY_COW
 465             header->readonly = 0;
 466 #    endif
 467 #  endif
 468 #  ifdef MDH_HAS_SIZE
 469             header->size = total_size;
 470 #  endif
 471             ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
 472         }
 473 #endif
 474         return ptr;
 475     }
 476     else {
 477 #ifndef ALWAYS_NEED_THX
 478         dTHX;
 479 #endif
 480         if (PL_nomemok)
 481             return NULL;
 482         croak_no_mem();
 483     }
 484 }
 485
 486 /* These must be defined when not using Perl's malloc for binary
 487  * compatibility */
 488
 489 #ifndef MYMALLOC
 490
 491 Malloc_t Perl_malloc (MEM_SIZE nbytes)
 492 {
 493 #ifdef PERL_IMPLICIT_SYS
 494     dTHX;
 495 #endif
 496     return (Malloc_t)PerlMem_malloc(nbytes);
 497 }
 498
 499 Malloc_t Perl_calloc (MEM_SIZE elements, MEM_SIZE size)
 500 {
 501 #ifdef PERL_IMPLICIT_SYS
 502     dTHX;
 503 #endif
 504     return (Malloc_t)PerlMem_calloc(elements, size);
 505 }
 506
 507 Malloc_t Perl_realloc (Malloc_t where, MEM_SIZE nbytes)
 508 {
 509 #ifdef PERL_IMPLICIT_SYS
 510     dTHX;
 511 #endif
 512     return (Malloc_t)PerlMem_realloc(where, nbytes);
 513 }
 514
 515 Free_t   Perl_mfree (Malloc_t where)
 516 {
 517 #ifdef PERL_IMPLICIT_SYS
 518     dTHX;
 519 #endif
 520     PerlMem_free(where);
 521 }
 522
 523 #endif
 524
 525 /* copy a string up to some (non-backslashed) delimiter, if any.
 526  * With allow_escape, converts \<delimiter> to <delimiter>, while leaves
 527  * \<non-delimiter> as-is.
 528  * Returns the position in the src string of the closing delimiter, if
 529  * any, or returns fromend otherwise.
 530  * This is the internal implementation for Perl_delimcpy and
 531  * Perl_delimcpy_no_escape.
 532  */
 533
 534 static char *
 535 S_delimcpy_intern(char *to, const char *toend, const char *from,
 536            const char *fromend, int delim, I32 *retlen,
 537            const bool allow_escape)
 538 {
 539     I32 tolen;
 540
 541     PERL_ARGS_ASSERT_DELIMCPY;
 542
 543     for (tolen = 0; from < fromend; from++, tolen++) {
 544         if (allow_escape && *from == '\\' && from + 1 < fromend) {
 545             if (from[1] != delim) {
 546                 if (to < toend)
 547                     *to++ = *from;
 548                 tolen++;
 549             }
 550             from++;
 551         }
 552         else if (*from == delim)
 553             break;
 554         if (to < toend)
 555             *to++ = *from;
 556     }
 557     if (to < toend)
 558         *to = '\0';
 559     *retlen = tolen;
 560     return (char *)from;
 561 }
 562
 563 char *
 564 Perl_delimcpy(char *to, const char *toend, const char *from, const char *fromend, int delim, I32 *retlen)
 565 {
 566     PERL_ARGS_ASSERT_DELIMCPY;
 567
 568     return S_delimcpy_intern(to, toend, from, fromend, delim, retlen, 1);
 569 }
 570
 571 char *
 572 Perl_delimcpy_no_escape(char *to, const char *toend, const char *from,
 573                         const char *fromend, int delim, I32 *retlen)
 574 {
 575     PERL_ARGS_ASSERT_DELIMCPY_NO_ESCAPE;
 576
 577     return S_delimcpy_intern(to, toend, from, fromend, delim, retlen, 0);
 578 }
 579
 580 /*
 581 =head1 Miscellaneous Functions
 582
 583 =for apidoc Am|char *|ninstr|char * big|char * bigend|char * little|char * little_end
 584
 585 Find the first (leftmost) occurrence of a sequence of bytes within another
 586 sequence.  This is the Perl version of C<strstr()>, extended to handle
 587 arbitrary sequences, potentially containing embedded C<NUL> characters (C<NUL>
 588 is what the initial C<n> in the function name stands for; some systems have an
 589 equivalent, C<memmem()>, but with a somewhat different API).
 590
 591 Another way of thinking about this function is finding a needle in a haystack.
 592 C<big> points to the first byte in the haystack.  C<big_end> points to one byte
 593 beyond the final byte in the haystack.  C<little> points to the first byte in
 594 the needle.  C<little_end> points to one byte beyond the final byte in the
 595 needle.  All the parameters must be non-C<NULL>.
 596
 597 The function returns C<NULL> if there is no occurrence of C<little> within
 598 C<big>.  If C<little> is the empty string, C<big> is returned.
 599
 600 Because this function operates at the byte level, and because of the inherent
 601 characteristics of UTF-8 (or UTF-EBCDIC), it will work properly if both the
 602 needle and the haystack are strings with the same UTF-8ness, but not if the
 603 UTF-8ness differs.
 604
 605 =cut
 606
 607 */
 608
 609 char *
 610 Perl_ninstr(const char *big, const char *bigend, const char *little, const char *lend)
 611 {
 612     PERL_ARGS_ASSERT_NINSTR;
 613
 614 #ifdef HAS_MEMMEM
 615     return ninstr(big, bigend, little, lend);
 616 #else
 617
 618     if (little >= lend)
 619         return (char*)big;
 620     {
 621         const char first = *little;
 622         bigend -= lend - little++;
 623     OUTER:
 624         while (big <= bigend) {
 625             if (*big++ == first) {
 626                 const char *s, *x;
 627                 for (x=big,s=little; s < lend; x++,s++) {
 628                     if (*s != *x)
 629                         goto OUTER;
 630                 }
 631                 return (char*)(big-1);
 632             }
 633         }
 634     }
 635     return NULL;
 636
 637 #endif
 638
 639 }
 640
 641 /*
 642 =head1 Miscellaneous Functions
 643
 644 =for apidoc Am|char *|rninstr|char * big|char * bigend|char * little|char * little_end
 645
 646 Like C<L</ninstr>>, but instead finds the final (rightmost) occurrence of a
 647 sequence of bytes within another sequence, returning C<NULL> if there is no
 648 such occurrence.
 649
 650 =cut
 651
 652 */
 653
 654 char *
 655 Perl_rninstr(const char *big, const char *bigend, const char *little, const char *lend)
 656 {
 657     const char *bigbeg;
 658     const I32 first = *little;
 659     const char * const littleend = lend;
 660
 661     PERL_ARGS_ASSERT_RNINSTR;
 662
 663     if (little >= littleend)
 664         return (char*)bigend;
 665     bigbeg = big;
 666     big = bigend - (littleend - little++);
 667     while (big >= bigbeg) {
 668         const char *s, *x;
 669         if (*big-- != first)
 670             continue;
 671         for (x=big+2,s=little; s < littleend; /**/ ) {
 672             if (*s != *x)
 673                 break;
 674             else {
 675                 x++;
 676                 s++;
 677             }
 678         }
 679         if (s >= littleend)
 680             return (char*)(big+1);
 681     }
 682     return NULL;
 683 }
 684
 685 /* As a space optimization, we do not compile tables for strings of length
 686    0 and 1, and for strings of length 2 unless FBMcf_TAIL.  These are
 687    special-cased in fbm_instr().
 688
 689    If FBMcf_TAIL, the table is created as if the string has a trailing \n. */
 690
 691 /*
 692 =head1 Miscellaneous Functions
 693
 694 =for apidoc fbm_compile
 695
 696 Analyses the string in order to make fast searches on it using C<fbm_instr()>
 697 -- the Boyer-Moore algorithm.
 698
 699 =cut
 700 */
 701
 702 void
 703 Perl_fbm_compile(pTHX_ SV *sv, U32 flags)
 704 {
 705     const U8 *s;
 706     STRLEN i;
 707     STRLEN len;
 708     U32 frequency = 256;
 709     MAGIC *mg;
 710     PERL_DEB( STRLEN rarest = 0 );
 711
 712     PERL_ARGS_ASSERT_FBM_COMPILE;
 713
 714     if (isGV_with_GP(sv) || SvROK(sv))
 715         return;
 716
 717     if (SvVALID(sv))
 718         return;
 719
 720     if (flags & FBMcf_TAIL) {
 721         MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
 722         sv_catpvs(sv, "\n");            /* Taken into account in fbm_instr() */
 723         if (mg && mg->mg_len >= 0)
 724             mg->mg_len++;
 725     }
 726     if (!SvPOK(sv) || SvNIOKp(sv))
 727         s = (U8*)SvPV_force_mutable(sv, len);
 728     else s = (U8 *)SvPV_mutable(sv, len);
 729     if (len == 0)               /* TAIL might be on a zero-length string. */
 730         return;
 731     SvUPGRADE(sv, SVt_PVMG);
 732     SvIOK_off(sv);
 733     SvNOK_off(sv);
 734
 735     /* add PERL_MAGIC_bm magic holding the FBM lookup table */
 736
 737     assert(!mg_find(sv, PERL_MAGIC_bm));
 738     mg = sv_magicext(sv, NULL, PERL_MAGIC_bm, &PL_vtbl_bm, NULL, 0);
 739     assert(mg);
 740
 741     if (len > 2) {
 742         /* Shorter strings are special-cased in Perl_fbm_instr(), and don't use
 743            the BM table.  */
 744         const U8 mlen = (len>255) ? 255 : (U8)len;
 745         const unsigned char *const sb = s + len - mlen; /* first char (maybe) */
 746         U8 *table;
 747
 748         Newx(table, 256, U8);
 749         memset((void*)table, mlen, 256);
 750         mg->mg_ptr = (char *)table;
 751         mg->mg_len = 256;
 752
 753         s += len - 1; /* last char */
 754         i = 0;
 755         while (s >= sb) {
 756             if (table[*s] == mlen)
 757                 table[*s] = (U8)i;
 758             s--, i++;
 759         }
 760     }
 761
 762     s = (const unsigned char*)(SvPVX_const(sv));        /* deeper magic */
 763     for (i = 0; i < len; i++) {
 764         if (PL_freq[s[i]] < frequency) {
 765             PERL_DEB( rarest = i );
 766             frequency = PL_freq[s[i]];
 767         }
 768     }
 769     BmUSEFUL(sv) = 100;                 /* Initial value */
 770     ((XPVNV*)SvANY(sv))->xnv_u.xnv_bm_tail = cBOOL(flags & FBMcf_TAIL);
 771     DEBUG_r(PerlIO_printf(Perl_debug_log, "rarest char %c at %" UVuf "\n",
 772                           s[rarest], (UV)rarest));
 773 }
 774
 775
 776 /*
 777 =for apidoc fbm_instr
 778
 779 Returns the location of the SV in the string delimited by C<big> and
 780 C<bigend> (C<bigend>) is the char following the last char).
 781 It returns C<NULL> if the string can't be found.  The C<sv>
 782 does not have to be C<fbm_compiled>, but the search will not be as fast
 783 then.
 784
 785 =cut
 786
 787 If SvTAIL(littlestr) is true, a fake "\n" was appended to to the string
 788 during FBM compilation due to FBMcf_TAIL in flags. It indicates that
 789 the littlestr must be anchored to the end of bigstr (or to any \n if
 790 FBMrf_MULTILINE).
 791
 792 E.g. The regex compiler would compile /abc/ to a littlestr of "abc",
 793 while /abc$/ compiles to "abc\n" with SvTAIL() true.
 794
 795 A littlestr of "abc", !SvTAIL matches as /abc/;
 796 a littlestr of "ab\n", SvTAIL matches as:
 797    without FBMrf_MULTILINE: /ab\n?\z/
 798    with    FBMrf_MULTILINE: /ab\n/ || /ab\z/;
 799
 800 (According to Ilya from 1999; I don't know if this is still true, DAPM 2015):
 801   "If SvTAIL is actually due to \Z or \z, this gives false positives
 802   if multiline".
 803 */
 804
 805
 806 char *
 807 Perl_fbm_instr(pTHX_ unsigned char *big, unsigned char *bigend, SV *littlestr, U32 flags)
 808 {
 809     unsigned char *s;
 810     STRLEN l;
 811     const unsigned char *little = (const unsigned char *)SvPV_const(littlestr,l);
 812     STRLEN littlelen = l;
 813     const I32 multiline = flags & FBMrf_MULTILINE;
 814     bool valid = SvVALID(littlestr);
 815     bool tail = valid ? cBOOL(SvTAIL(littlestr)) : FALSE;
 816
 817     PERL_ARGS_ASSERT_FBM_INSTR;
 818
 819     assert(bigend >= big);
 820
 821     if ((STRLEN)(bigend - big) < littlelen) {
 822         if (     tail
 823              && ((STRLEN)(bigend - big) == littlelen - 1)
 824              && (littlelen == 1
 825                  || (*big == *little &&
 826                      memEQ((char *)big, (char *)little, littlelen - 1))))
 827             return (char*)big;
 828         return NULL;
 829     }
 830
 831     switch (littlelen) { /* Special cases for 0, 1 and 2  */
 832     case 0:
 833         return (char*)big;              /* Cannot be SvTAIL! */
 834
 835     case 1:
 836             if (tail && !multiline) /* Anchor only! */
 837                 /* [-1] is safe because we know that bigend != big.  */
 838                 return (char *) (bigend - (bigend[-1] == '\n'));
 839
 840             s = (unsigned char *)memchr((void*)big, *little, bigend-big);
 841             if (s)
 842                 return (char *)s;
 843             if (tail)
 844                 return (char *) bigend;
 845             return NULL;
 846
 847     case 2:
 848         if (tail && !multiline) {
 849             /* a littlestr with SvTAIL must be of the form "X\n" (where X
 850              * is a single char). It is anchored, and can only match
 851              * "....X\n"  or  "....X" */
 852             if (bigend[-2] == *little && bigend[-1] == '\n')
 853                 return (char*)bigend - 2;
 854             if (bigend[-1] == *little)
 855                 return (char*)bigend - 1;
 856             return NULL;
 857         }
 858
 859         {
 860             /* memchr() is likely to be very fast, possibly using whatever
 861              * hardware support is available, such as checking a whole
 862              * cache line in one instruction.
 863              * So for a 2 char pattern, calling memchr() is likely to be
 864              * faster than running FBM, or rolling our own. The previous
 865              * version of this code was roll-your-own which typically
 866              * only needed to read every 2nd char, which was good back in
 867              * the day, but no longer.
 868              */
 869             unsigned char c1 = little[0];
 870             unsigned char c2 = little[1];
 871
 872             /* *** for all this case, bigend points to the last char,
 873              * not the trailing \0: this makes the conditions slightly
 874              * simpler */
 875             bigend--;
 876             s = big;
 877             if (c1 != c2) {
 878                 while (s < bigend) {
 879                     /* do a quick test for c1 before calling memchr();
 880                      * this avoids the expensive fn call overhead when
 881                      * there are lots of c1's */
 882                     if (LIKELY(*s != c1)) {
 883                         s++;
 884                         s = (unsigned char *)memchr((void*)s, c1, bigend - s);
 885                         if (!s)
 886                             break;
 887                     }
 888                     if (s[1] == c2)
 889                         return (char*)s;
 890
 891                     /* failed; try searching for c2 this time; that way
 892                      * we don't go pathologically slow when the string
 893                      * consists mostly of c1's or vice versa.
 894                      */
 895                     s += 2;
 896                     if (s > bigend)
 897                         break;
 898                     s = (unsigned char *)memchr((void*)s, c2, bigend - s + 1);
 899                     if (!s)
 900                         break;
 901                     if (s[-1] == c1)
 902                         return (char*)s - 1;
 903                 }
 904             }
 905             else {
 906                 /* c1, c2 the same */
 907                 while (s < bigend) {
 908                     if (s[0] == c1) {
 909                       got_1char:
 910                         if (s[1] == c1)
 911                             return (char*)s;
 912                         s += 2;
 913                     }
 914                     else {
 915                         s++;
 916                         s = (unsigned char *)memchr((void*)s, c1, bigend - s);
 917                         if (!s || s >= bigend)
 918                             break;
 919                         goto got_1char;
 920                     }
 921                 }
 922             }
 923
 924             /* failed to find 2 chars; try anchored match at end without
 925              * the \n */
 926             if (tail && bigend[0] == little[0])
 927                 return (char *)bigend;
 928             return NULL;
 929         }
 930
 931     default:
 932         break; /* Only lengths 0 1 and 2 have special-case code.  */
 933     }
 934
 935     if (tail && !multiline) {   /* tail anchored? */
 936         s = bigend - littlelen;
 937         if (s >= big && bigend[-1] == '\n' && *s == *little
 938             /* Automatically of length > 2 */
 939             && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
 940         {
 941             return (char*)s;            /* how sweet it is */
 942         }
 943         if (s[1] == *little
 944             && memEQ((char*)s + 2, (char*)little + 1, littlelen - 2))
 945         {
 946             return (char*)s + 1;        /* how sweet it is */
 947         }
 948         return NULL;
 949     }
 950
 951     if (!valid) {
 952         /* not compiled; use Perl_ninstr() instead */
 953         char * const b = ninstr((char*)big,(char*)bigend,
 954                          (char*)little, (char*)little + littlelen);
 955
 956         assert(!tail); /* valid => FBM; tail only set on SvVALID SVs */
 957         return b;
 958     }
 959
 960     /* Do actual FBM.  */
 961     if (littlelen > (STRLEN)(bigend - big))
 962         return NULL;
 963
 964     {
 965         const MAGIC *const mg = mg_find(littlestr, PERL_MAGIC_bm);
 966         const unsigned char *oldlittle;
 967
 968         assert(mg);
 969
 970         --littlelen;                    /* Last char found by table lookup */
 971
 972         s = big + littlelen;
 973         little += littlelen;            /* last char */
 974         oldlittle = little;
 975         if (s < bigend) {
 976             const unsigned char * const table = (const unsigned char *) mg->mg_ptr;
 977             const unsigned char lastc = *little;
 978             I32 tmp;
 979
 980           top2:
 981             if ((tmp = table[*s])) {
 982                 /* *s != lastc; earliest position it could match now is
 983                  * tmp slots further on */
 984                 if ((s += tmp) >= bigend)
 985                     goto check_end;
 986                 if (LIKELY(*s != lastc)) {
 987                     s++;
 988                     s = (unsigned char *)memchr((void*)s, lastc, bigend - s);
 989                     if (!s) {
 990                         s = bigend;
 991                         goto check_end;
 992                     }
 993                     goto top2;
 994                 }
 995             }
 996
 997
 998             /* hand-rolled strncmp(): less expensive than calling the
 999              * real function (maybe???) */
1000             {
1001                 unsigned char * const olds = s;
1002
1003                 tmp = littlelen;
1004
1005                 while (tmp--) {
1006                     if (*--s == *--little)
1007                         continue;
1008                     s = olds + 1;       /* here we pay the price for failure */
1009                     little = oldlittle;
1010                     if (s < bigend)     /* fake up continue to outer loop */
1011                         goto top2;
1012                     goto check_end;
1013                 }
1014                 return (char *)s;
1015             }
1016         }
1017       check_end:
1018         if ( s == bigend
1019              && tail
1020              && memEQ((char *)(bigend - littlelen),
1021                       (char *)(oldlittle - littlelen), littlelen) )
1022             return (char*)bigend - littlelen;
1023         return NULL;
1024     }
1025 }
1026
1027 /* copy a string to a safe spot */
1028
1029 /*
1030 =head1 Memory Management
1031
1032 =for apidoc savepv
1033
1034 Perl's version of C<strdup()>.  Returns a pointer to a newly allocated
1035 string which is a duplicate of C<pv>.  The size of the string is
1036 determined by C<strlen()>, which means it may not contain embedded C<NUL>
1037 characters and must have a trailing C<NUL>.  The memory allocated for the new
1038 string can be freed with the C<Safefree()> function.
1039
1040 On some platforms, Windows for example, all allocated memory owned by a thread
1041 is deallocated when that thread ends.  So if you need that not to happen, you
1042 need to use the shared memory functions, such as C<L</savesharedpv>>.
1043
1044 =cut
1045 */
1046
1047 char *
1048 Perl_savepv(pTHX_ const char *pv)
1049 {
1050     PERL_UNUSED_CONTEXT;
1051     if (!pv)
1052         return NULL;
1053     else {
1054         char *newaddr;
1055         const STRLEN pvlen = strlen(pv)+1;
1056         Newx(newaddr, pvlen, char);
1057         return (char*)memcpy(newaddr, pv, pvlen);
1058     }
1059 }
1060
1061 /* same thing but with a known length */
1062
1063 /*
1064 =for apidoc savepvn
1065
1066 Perl's version of what C<strndup()> would be if it existed.  Returns a
1067 pointer to a newly allocated string which is a duplicate of the first
1068 C<len> bytes from C<pv>, plus a trailing
1069 C<NUL> byte.  The memory allocated for
1070 the new string can be freed with the C<Safefree()> function.
1071
1072 On some platforms, Windows for example, all allocated memory owned by a thread
1073 is deallocated when that thread ends.  So if you need that not to happen, you
1074 need to use the shared memory functions, such as C<L</savesharedpvn>>.
1075
1076 =cut
1077 */
1078
1079 char *
1080 Perl_savepvn(pTHX_ const char *pv, I32 len)
1081 {
1082     char *newaddr;
1083     PERL_UNUSED_CONTEXT;
1084
1085     assert(len >= 0);
1086
1087     Newx(newaddr,len+1,char);
1088     /* Give a meaning to NULL pointer mainly for the use in sv_magic() */
1089     if (pv) {
1090         /* might not be null terminated */
1091         newaddr[len] = '\0';
1092         return (char *) CopyD(pv,newaddr,len,char);
1093     }
1094     else {
1095         return (char *) ZeroD(newaddr,len+1,char);
1096     }
1097 }
1098
1099 /*
1100 =for apidoc savesharedpv
1101
1102 A version of C<savepv()> which allocates the duplicate string in memory
1103 which is shared between threads.
1104
1105 =cut
1106 */
1107 char *
1108 Perl_savesharedpv(pTHX_ const char *pv)
1109 {
1110     char *newaddr;
1111     STRLEN pvlen;
1112
1113     PERL_UNUSED_CONTEXT;
1114
1115     if (!pv)
1116         return NULL;
1117
1118     pvlen = strlen(pv)+1;
1119     newaddr = (char*)PerlMemShared_malloc(pvlen);
1120     if (!newaddr) {
1121         croak_no_mem();
1122     }
1123     return (char*)memcpy(newaddr, pv, pvlen);
1124 }
1125
1126 /*
1127 =for apidoc savesharedpvn
1128
1129 A version of C<savepvn()> which allocates the duplicate string in memory
1130 which is shared between threads.  (With the specific difference that a C<NULL>
1131 pointer is not acceptable)
1132
1133 =cut
1134 */
1135 char *
1136 Perl_savesharedpvn(pTHX_ const char *const pv, const STRLEN len)
1137 {
1138     char *const newaddr = (char*)PerlMemShared_malloc(len + 1);
1139
1140     PERL_UNUSED_CONTEXT;
1141     /* PERL_ARGS_ASSERT_SAVESHAREDPVN; */
1142
1143     if (!newaddr) {
1144         croak_no_mem();
1145     }
1146     newaddr[len] = '\0';
1147     return (char*)memcpy(newaddr, pv, len);
1148 }
1149
1150 /*
1151 =for apidoc savesvpv
1152
1153 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1154 the passed in SV using C<SvPV()>
1155
1156 On some platforms, Windows for example, all allocated memory owned by a thread
1157 is deallocated when that thread ends.  So if you need that not to happen, you
1158 need to use the shared memory functions, such as C<L</savesharedsvpv>>.
1159
1160 =cut
1161 */
1162
1163 char *
1164 Perl_savesvpv(pTHX_ SV *sv)
1165 {
1166     STRLEN len;
1167     const char * const pv = SvPV_const(sv, len);
1168     char *newaddr;
1169
1170     PERL_ARGS_ASSERT_SAVESVPV;
1171
1172     ++len;
1173     Newx(newaddr,len,char);
1174     return (char *) CopyD(pv,newaddr,len,char);
1175 }
1176
1177 /*
1178 =for apidoc savesharedsvpv
1179
1180 A version of C<savesharedpv()> which allocates the duplicate string in
1181 memory which is shared between threads.
1182
1183 =cut
1184 */
1185
1186 char *
1187 Perl_savesharedsvpv(pTHX_ SV *sv)
1188 {
1189     STRLEN len;
1190     const char * const pv = SvPV_const(sv, len);
1191
1192     PERL_ARGS_ASSERT_SAVESHAREDSVPV;
1193
1194     return savesharedpvn(pv, len);
1195 }
1196
1197 /* the SV for Perl_form() and mess() is not kept in an arena */
1198
1199 STATIC SV *
1200 S_mess_alloc(pTHX)
1201 {
1202     SV *sv;
1203     XPVMG *any;
1204
1205     if (PL_phase != PERL_PHASE_DESTRUCT)
1206         return newSVpvs_flags("", SVs_TEMP);
1207
1208     if (PL_mess_sv)
1209         return PL_mess_sv;
1210
1211     /* Create as PVMG now, to avoid any upgrading later */
1212     Newx(sv, 1, SV);
1213     Newxz(any, 1, XPVMG);
1214     SvFLAGS(sv) = SVt_PVMG;
1215     SvANY(sv) = (void*)any;
1216     SvPV_set(sv, NULL);
1217     SvREFCNT(sv) = 1 << 30; /* practically infinite */
1218     PL_mess_sv = sv;
1219     return sv;
1220 }
1221
1222 #if defined(PERL_IMPLICIT_CONTEXT)
1223 char *
1224 Perl_form_nocontext(const char* pat, ...)
1225 {
1226     dTHX;
1227     char *retval;
1228     va_list args;
1229     PERL_ARGS_ASSERT_FORM_NOCONTEXT;
1230     va_start(args, pat);
1231     retval = vform(pat, &args);
1232     va_end(args);
1233     return retval;
1234 }
1235 #endif /* PERL_IMPLICIT_CONTEXT */
1236
1237 /*
1238 =head1 Miscellaneous Functions
1239 =for apidoc form
1240
1241 Takes a sprintf-style format pattern and conventional
1242 (non-SV) arguments and returns the formatted string.
1243
1244     (char *) Perl_form(pTHX_ const char* pat, ...)
1245
1246 can be used any place a string (char *) is required:
1247
1248     char * s = Perl_form("%d.%d",major,minor);
1249
1250 Uses a single private buffer so if you want to format several strings you
1251 must explicitly copy the earlier strings away (and free the copies when you
1252 are done).
1253
1254 =cut
1255 */
1256
1257 char *
1258 Perl_form(pTHX_ const char* pat, ...)
1259 {
1260     char *retval;
1261     va_list args;
1262     PERL_ARGS_ASSERT_FORM;
1263     va_start(args, pat);
1264     retval = vform(pat, &args);
1265     va_end(args);
1266     return retval;
1267 }
1268
1269 char *
1270 Perl_vform(pTHX_ const char *pat, va_list *args)
1271 {
1272     SV * const sv = mess_alloc();
1273     PERL_ARGS_ASSERT_VFORM;
1274     sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1275     return SvPVX(sv);
1276 }
1277
1278 /*
1279 =for apidoc Am|SV *|mess|const char *pat|...
1280
1281 Take a sprintf-style format pattern and argument list.  These are used to
1282 generate a string message.  If the message does not end with a newline,
1283 then it will be extended with some indication of the current location
1284 in the code, as described for L</mess_sv>.
1285
1286 Normally, the resulting message is returned in a new mortal SV.
1287 During global destruction a single SV may be shared between uses of
1288 this function.
1289
1290 =cut
1291 */
1292
1293 #if defined(PERL_IMPLICIT_CONTEXT)
1294 SV *
1295 Perl_mess_nocontext(const char *pat, ...)
1296 {
1297     dTHX;
1298     SV *retval;
1299     va_list args;
1300     PERL_ARGS_ASSERT_MESS_NOCONTEXT;
1301     va_start(args, pat);
1302     retval = vmess(pat, &args);
1303     va_end(args);
1304     return retval;
1305 }
1306 #endif /* PERL_IMPLICIT_CONTEXT */
1307
1308 SV *
1309 Perl_mess(pTHX_ const char *pat, ...)
1310 {
1311     SV *retval;
1312     va_list args;
1313     PERL_ARGS_ASSERT_MESS;
1314     va_start(args, pat);
1315     retval = vmess(pat, &args);
1316     va_end(args);
1317     return retval;
1318 }
1319
1320 const COP*
1321 Perl_closest_cop(pTHX_ const COP *cop, const OP *o, const OP *curop,
1322                        bool opnext)
1323 {
1324     /* Look for curop starting from o.  cop is the last COP we've seen. */
1325     /* opnext means that curop is actually the ->op_next of the op we are
1326        seeking. */
1327
1328     PERL_ARGS_ASSERT_CLOSEST_COP;
1329
1330     if (!o || !curop || (
1331         opnext ? o->op_next == curop && o->op_type != OP_SCOPE : o == curop
1332     ))
1333         return cop;
1334
1335     if (o->op_flags & OPf_KIDS) {
1336         const OP *kid;
1337         for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid)) {
1338             const COP *new_cop;
1339
1340             /* If the OP_NEXTSTATE has been optimised away we can still use it
1341              * the get the file and line number. */
1342
1343             if (kid->op_type == OP_NULL && kid->op_targ == OP_NEXTSTATE)
1344                 cop = (const COP *)kid;
1345
1346             /* Keep searching, and return when we've found something. */
1347
1348             new_cop = closest_cop(cop, kid, curop, opnext);
1349             if (new_cop)
1350                 return new_cop;
1351         }
1352     }
1353
1354     /* Nothing found. */
1355
1356     return NULL;
1357 }
1358
1359 /*
1360 =for apidoc Am|SV *|mess_sv|SV *basemsg|bool consume
1361
1362 Expands a message, intended for the user, to include an indication of
1363 the current location in the code, if the message does not already appear
1364 to be complete.
1365
1366 C<basemsg> is the initial message or object.  If it is a reference, it
1367 will be used as-is and will be the result of this function.  Otherwise it
1368 is used as a string, and if it already ends with a newline, it is taken
1369 to be complete, and the result of this function will be the same string.
1370 If the message does not end with a newline, then a segment such as C<at
1371 foo.pl line 37> will be appended, and possibly other clauses indicating
1372 the current state of execution.  The resulting message will end with a
1373 dot and a newline.
1374
1375 Normally, the resulting message is returned in a new mortal SV.
1376 During global destruction a single SV may be shared between uses of this
1377 function.  If C<consume> is true, then the function is permitted (but not
1378 required) to modify and return C<basemsg> instead of allocating a new SV.
1379
1380 =cut
1381 */
1382
1383 SV *
1384 Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
1385 {
1386     SV *sv;
1387
1388 #if defined(USE_C_BACKTRACE) && defined(USE_C_BACKTRACE_ON_ERROR)
1389     {
1390         char *ws;
1391         UV wi;
1392         /* The PERL_C_BACKTRACE_ON_WARN must be an integer of one or more. */
1393         if ((ws = PerlEnv_getenv("PERL_C_BACKTRACE_ON_ERROR"))
1394             && grok_atoUV(ws, &wi, NULL)
1395             && wi <= PERL_INT_MAX
1396         ) {
1397             Perl_dump_c_backtrace(aTHX_ Perl_debug_log, (int)wi, 1);
1398         }
1399     }
1400 #endif
1401
1402     PERL_ARGS_ASSERT_MESS_SV;
1403
1404     if (SvROK(basemsg)) {
1405         if (consume) {
1406             sv = basemsg;
1407         }
1408         else {
1409             sv = mess_alloc();
1410             sv_setsv(sv, basemsg);
1411         }
1412         return sv;
1413     }
1414
1415     if (SvPOK(basemsg) && consume) {
1416         sv = basemsg;
1417     }
1418     else {
1419         sv = mess_alloc();
1420         sv_copypv(sv, basemsg);
1421     }
1422
1423     if (!SvCUR(sv) || *(SvEND(sv) - 1) != '\n') {
1424         /*
1425          * Try and find the file and line for PL_op.  This will usually be
1426          * PL_curcop, but it might be a cop that has been optimised away.  We
1427          * can try to find such a cop by searching through the optree starting
1428          * from the sibling of PL_curcop.
1429          */
1430
1431         if (PL_curcop) {
1432             const COP *cop =
1433                 closest_cop(PL_curcop, OpSIBLING(PL_curcop), PL_op, FALSE);
1434             if (!cop)
1435                 cop = PL_curcop;
1436
1437             if (CopLINE(cop))
1438                 Perl_sv_catpvf(aTHX_ sv, " at %s line %" IVdf,
1439                                 OutCopFILE(cop), (IV)CopLINE(cop));
1440         }
1441
1442         /* Seems that GvIO() can be untrustworthy during global destruction. */
1443         if (GvIO(PL_last_in_gv) && (SvTYPE(GvIOp(PL_last_in_gv)) == SVt_PVIO)
1444                 && IoLINES(GvIOp(PL_last_in_gv)))
1445         {
1446             STRLEN l;
1447             const bool line_mode = (RsSIMPLE(PL_rs) &&
1448                                    *SvPV_const(PL_rs,l) == '\n' && l == 1);
1449             Perl_sv_catpvf(aTHX_ sv, ", <%" SVf "> %s %" IVdf,
1450                            SVfARG(PL_last_in_gv == PL_argvgv
1451                                  ? &PL_sv_no
1452                                  : sv_2mortal(newSVhek(GvNAME_HEK(PL_last_in_gv)))),
1453                            line_mode ? "line" : "chunk",
1454                            (IV)IoLINES(GvIOp(PL_last_in_gv)));
1455         }
1456         if (PL_phase == PERL_PHASE_DESTRUCT)
1457             sv_catpvs(sv, " during global destruction");
1458         sv_catpvs(sv, ".\n");
1459     }
1460     return sv;
1461 }
1462
1463 /*
1464 =for apidoc Am|SV *|vmess|const char *pat|va_list *args
1465
1466 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1467 argument list, respectively.  These are used to generate a string message.  If
1468 the
1469 message does not end with a newline, then it will be extended with
1470 some indication of the current location in the code, as described for
1471 L</mess_sv>.
1472
1473 Normally, the resulting message is returned in a new mortal SV.
1474 During global destruction a single SV may be shared between uses of
1475 this function.
1476
1477 =cut
1478 */
1479
1480 SV *
1481 Perl_vmess(pTHX_ const char *pat, va_list *args)
1482 {
1483     SV * const sv = mess_alloc();
1484
1485     PERL_ARGS_ASSERT_VMESS;
1486
1487     sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1488     return mess_sv(sv, 1);
1489 }
1490
1491 void
1492 Perl_write_to_stderr(pTHX_ SV* msv)
1493 {
1494     IO *io;
1495     MAGIC *mg;
1496
1497     PERL_ARGS_ASSERT_WRITE_TO_STDERR;
1498
1499     if (PL_stderrgv && SvREFCNT(PL_stderrgv)
1500         && (io = GvIO(PL_stderrgv))
1501         && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
1502         Perl_magic_methcall(aTHX_ MUTABLE_SV(io), mg, SV_CONST(PRINT),
1503                             G_SCALAR | G_DISCARD | G_WRITING_TO_STDERR, 1, msv);
1504     else {
1505         PerlIO * const serr = Perl_error_log;
1506
1507         do_print(msv, serr);
1508         (void)PerlIO_flush(serr);
1509     }
1510 }
1511
1512 /*
1513 =head1 Warning and Dieing
1514 */
1515
1516 /* Common code used in dieing and warning */
1517
1518 STATIC SV *
1519 S_with_queued_errors(pTHX_ SV *ex)
1520 {
1521     PERL_ARGS_ASSERT_WITH_QUEUED_ERRORS;
1522     if (PL_errors && SvCUR(PL_errors) && !SvROK(ex)) {
1523         sv_catsv(PL_errors, ex);
1524         ex = sv_mortalcopy(PL_errors);
1525         SvCUR_set(PL_errors, 0);
1526     }
1527     return ex;
1528 }
1529
1530 STATIC bool
1531 S_invoke_exception_hook(pTHX_ SV *ex, bool warn)
1532 {
1533     HV *stash;
1534     GV *gv;
1535     CV *cv;
1536     SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1537     /* sv_2cv might call Perl_croak() or Perl_warner() */
1538     SV * const oldhook = *hook;
1539
1540     if (!oldhook)
1541         return FALSE;
1542
1543     ENTER;
1544     SAVESPTR(*hook);
1545     *hook = NULL;
1546     cv = sv_2cv(oldhook, &stash, &gv, 0);
1547     LEAVE;
1548     if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1549         dSP;
1550         SV *exarg;
1551
1552         ENTER;
1553         save_re_context();
1554         if (warn) {
1555             SAVESPTR(*hook);
1556             *hook = NULL;
1557         }
1558         exarg = newSVsv(ex);
1559         SvREADONLY_on(exarg);
1560         SAVEFREESV(exarg);
1561
1562         PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
1563         PUSHMARK(SP);
1564         XPUSHs(exarg);
1565         PUTBACK;
1566         call_sv(MUTABLE_SV(cv), G_DISCARD);
1567         POPSTACK;
1568         LEAVE;
1569         return TRUE;
1570     }
1571     return FALSE;
1572 }
1573
1574 /*
1575 =for apidoc Am|OP *|die_sv|SV *baseex
1576
1577 Behaves the same as L</croak_sv>, except for the return type.
1578 It should be used only where the C<OP *> return type is required.
1579 The function never actually returns.
1580
1581 =cut
1582 */
1583
1584 #ifdef _MSC_VER
1585 #  pragma warning( push )
1586 #  pragma warning( disable : 4646 ) /* warning C4646: function declared with
1587     __declspec(noreturn) has non-void return type */
1588 #  pragma warning( disable : 4645 ) /* warning C4645: function declared with
1589 __declspec(noreturn) has a return statement */
1590 #endif
1591 OP *
1592 Perl_die_sv(pTHX_ SV *baseex)
1593 {
1594     PERL_ARGS_ASSERT_DIE_SV;
1595     croak_sv(baseex);
1596     /* NOTREACHED */
1597     NORETURN_FUNCTION_END;
1598 }
1599 #ifdef _MSC_VER
1600 #  pragma warning( pop )
1601 #endif
1602
1603 /*
1604 =for apidoc Am|OP *|die|const char *pat|...
1605
1606 Behaves the same as L</croak>, except for the return type.
1607 It should be used only where the C<OP *> return type is required.
1608 The function never actually returns.
1609
1610 =cut
1611 */
1612
1613 #if defined(PERL_IMPLICIT_CONTEXT)
1614 #ifdef _MSC_VER
1615 #  pragma warning( push )
1616 #  pragma warning( disable : 4646 ) /* warning C4646: function declared with
1617     __declspec(noreturn) has non-void return type */
1618 #  pragma warning( disable : 4645 ) /* warning C4645: function declared with
1619 __declspec(noreturn) has a return statement */
1620 #endif
1621 OP *
1622 Perl_die_nocontext(const char* pat, ...)
1623 {
1624     dTHX;
1625     va_list args;
1626     va_start(args, pat);
1627     vcroak(pat, &args);
1628     NOT_REACHED; /* NOTREACHED */
1629     va_end(args);
1630     NORETURN_FUNCTION_END;
1631 }
1632 #ifdef _MSC_VER
1633 #  pragma warning( pop )
1634 #endif
1635 #endif /* PERL_IMPLICIT_CONTEXT */
1636
1637 #ifdef _MSC_VER
1638 #  pragma warning( push )
1639 #  pragma warning( disable : 4646 ) /* warning C4646: function declared with
1640     __declspec(noreturn) has non-void return type */
1641 #  pragma warning( disable : 4645 ) /* warning C4645: function declared with
1642 __declspec(noreturn) has a return statement */
1643 #endif
1644 OP *
1645 Perl_die(pTHX_ const char* pat, ...)
1646 {
1647     va_list args;
1648     va_start(args, pat);
1649     vcroak(pat, &args);
1650     NOT_REACHED; /* NOTREACHED */
1651     va_end(args);
1652     NORETURN_FUNCTION_END;
1653 }
1654 #ifdef _MSC_VER
1655 #  pragma warning( pop )
1656 #endif
1657
1658 /*
1659 =for apidoc Am|void|croak_sv|SV *baseex
1660
1661 This is an XS interface to Perl's C<die> function.
1662
1663 C<baseex> is the error message or object.  If it is a reference, it
1664 will be used as-is.  Otherwise it is used as a string, and if it does
1665 not end with a newline then it will be extended with some indication of
1666 the current location in the code, as described for L</mess_sv>.
1667
1668 The error message or object will be used as an exception, by default
1669 returning control to the nearest enclosing C<eval>, but subject to
1670 modification by a C<$SIG{__DIE__}> handler.  In any case, the C<croak_sv>
1671 function never returns normally.
1672
1673 To die with a simple string message, the L</croak> function may be
1674 more convenient.
1675
1676 =cut
1677 */
1678
1679 void
1680 Perl_croak_sv(pTHX_ SV *baseex)
1681 {
1682     SV *ex = with_queued_errors(mess_sv(baseex, 0));
1683     PERL_ARGS_ASSERT_CROAK_SV;
1684     invoke_exception_hook(ex, FALSE);
1685     die_unwind(ex);
1686 }
1687
1688 /*
1689 =for apidoc Am|void|vcroak|const char *pat|va_list *args
1690
1691 This is an XS interface to Perl's C<die> function.
1692
1693 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1694 argument list.  These are used to generate a string message.  If the
1695 message does not end with a newline, then it will be extended with
1696 some indication of the current location in the code, as described for
1697 L</mess_sv>.
1698
1699 The error message will be used as an exception, by default
1700 returning control to the nearest enclosing C<eval>, but subject to
1701 modification by a C<$SIG{__DIE__}> handler.  In any case, the C<croak>
1702 function never returns normally.
1703
1704 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1705 (C<$@>) will be used as an error message or object instead of building an
1706 error message from arguments.  If you want to throw a non-string object,
1707 or build an error message in an SV yourself, it is preferable to use
1708 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1709
1710 =cut
1711 */
1712
1713 void
1714 Perl_vcroak(pTHX_ const char* pat, va_list *args)
1715 {
1716     SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1717     invoke_exception_hook(ex, FALSE);
1718     die_unwind(ex);
1719 }
1720
1721 /*
1722 =for apidoc Am|void|croak|const char *pat|...
1723
1724 This is an XS interface to Perl's C<die> function.
1725
1726 Take a sprintf-style format pattern and argument list.  These are used to
1727 generate a string message.  If the message does not end with a newline,
1728 then it will be extended with some indication of the current location
1729 in the code, as described for L</mess_sv>.
1730
1731 The error message will be used as an exception, by default
1732 returning control to the nearest enclosing C<eval>, but subject to
1733 modification by a C<$SIG{__DIE__}> handler.  In any case, the C<croak>
1734 function never returns normally.
1735
1736 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1737 (C<$@>) will be used as an error message or object instead of building an
1738 error message from arguments.  If you want to throw a non-string object,
1739 or build an error message in an SV yourself, it is preferable to use
1740 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1741
1742 =cut
1743 */
1744
1745 #if defined(PERL_IMPLICIT_CONTEXT)
1746 void
1747 Perl_croak_nocontext(const char *pat, ...)
1748 {
1749     dTHX;
1750     va_list args;
1751     va_start(args, pat);
1752     vcroak(pat, &args);
1753     NOT_REACHED; /* NOTREACHED */
1754     va_end(args);
1755 }
1756 #endif /* PERL_IMPLICIT_CONTEXT */
1757
1758 void
1759 Perl_croak(pTHX_ const char *pat, ...)
1760 {
1761     va_list args;
1762     va_start(args, pat);
1763     vcroak(pat, &args);
1764     NOT_REACHED; /* NOTREACHED */
1765     va_end(args);
1766 }
1767
1768 /*
1769 =for apidoc Am|void|croak_no_modify
1770
1771 Exactly equivalent to C<Perl_croak(aTHX_ "%s", PL_no_modify)>, but generates
1772 terser object code than using C<Perl_croak>.  Less code used on exception code
1773 paths reduces CPU cache pressure.
1774
1775 =cut
1776 */
1777
1778 void
1779 Perl_croak_no_modify(void)
1780 {
1781     Perl_croak_nocontext( "%s", PL_no_modify);
1782 }
1783
1784 /* does not return, used in util.c perlio.c and win32.c
1785    This is typically called when malloc returns NULL.
1786 */
1787 void
1788 Perl_croak_no_mem(void)
1789 {
1790     dTHX;
1791
1792     int fd = PerlIO_fileno(Perl_error_log);
1793     if (fd < 0)
1794         SETERRNO(EBADF,RMS_IFI);
1795     else {
1796         /* Can't use PerlIO to write as it allocates memory */
1797         PERL_UNUSED_RESULT(PerlLIO_write(fd, PL_no_mem, sizeof(PL_no_mem)-1));
1798     }
1799     my_exit(1);
1800 }
1801
1802 /* does not return, used only in POPSTACK */
1803 void
1804 Perl_croak_popstack(void)
1805 {
1806     dTHX;
1807     PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");
1808     my_exit(1);
1809 }
1810
1811 /*
1812 =for apidoc Am|void|warn_sv|SV *baseex
1813
1814 This is an XS interface to Perl's C<warn> function.
1815
1816 C<baseex> is the error message or object.  If it is a reference, it
1817 will be used as-is.  Otherwise it is used as a string, and if it does
1818 not end with a newline then it will be extended with some indication of
1819 the current location in the code, as described for L</mess_sv>.
1820
1821 The error message or object will by default be written to standard error,
1822 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1823
1824 To warn with a simple string message, the L</warn> function may be
1825 more convenient.
1826
1827 =cut
1828 */
1829
1830 void
1831 Perl_warn_sv(pTHX_ SV *baseex)
1832 {
1833     SV *ex = mess_sv(baseex, 0);
1834     PERL_ARGS_ASSERT_WARN_SV;
1835     if (!invoke_exception_hook(ex, TRUE))
1836         write_to_stderr(ex);
1837 }
1838
1839 /*
1840 =for apidoc Am|void|vwarn|const char *pat|va_list *args
1841
1842 This is an XS interface to Perl's C<warn> function.
1843
1844 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1845 argument list.  These are used to generate a string message.  If the
1846 message does not end with a newline, then it will be extended with
1847 some indication of the current location in the code, as described for
1848 L</mess_sv>.
1849
1850 The error message or object will by default be written to standard error,
1851 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1852
1853 Unlike with L</vcroak>, C<pat> is not permitted to be null.
1854
1855 =cut
1856 */
1857
1858 void
1859 Perl_vwarn(pTHX_ const char* pat, va_list *args)
1860 {
1861     SV *ex = vmess(pat, args);
1862     PERL_ARGS_ASSERT_VWARN;
1863     if (!invoke_exception_hook(ex, TRUE))
1864         write_to_stderr(ex);
1865 }
1866
1867 /*
1868 =for apidoc Am|void|warn|const char *pat|...
1869
1870 This is an XS interface to Perl's C<warn> function.
1871
1872 Take a sprintf-style format pattern and argument list.  These are used to
1873 generate a string message.  If the message does not end with a newline,
1874 then it will be extended with some indication of the current location
1875 in the code, as described for L</mess_sv>.
1876
1877 The error message or object will by default be written to standard error,
1878 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1879
1880 Unlike with L</croak>, C<pat> is not permitted to be null.
1881
1882 =cut
1883 */
1884
1885 #if defined(PERL_IMPLICIT_CONTEXT)
1886 void
1887 Perl_warn_nocontext(const char *pat, ...)
1888 {
1889     dTHX;
1890     va_list args;
1891     PERL_ARGS_ASSERT_WARN_NOCONTEXT;
1892     va_start(args, pat);
1893     vwarn(pat, &args);
1894     va_end(args);
1895 }
1896 #endif /* PERL_IMPLICIT_CONTEXT */
1897
1898 void
1899 Perl_warn(pTHX_ const char *pat, ...)
1900 {
1901     va_list args;
1902     PERL_ARGS_ASSERT_WARN;
1903     va_start(args, pat);
1904     vwarn(pat, &args);
1905     va_end(args);
1906 }
1907
1908 #if defined(PERL_IMPLICIT_CONTEXT)
1909 void
1910 Perl_warner_nocontext(U32 err, const char *pat, ...)
1911 {
1912     dTHX;
1913     va_list args;
1914     PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
1915     va_start(args, pat);
1916     vwarner(err, pat, &args);
1917     va_end(args);
1918 }
1919 #endif /* PERL_IMPLICIT_CONTEXT */
1920
1921 void
1922 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
1923 {
1924     PERL_ARGS_ASSERT_CK_WARNER_D;
1925
1926     if (Perl_ckwarn_d(aTHX_ err)) {
1927         va_list args;
1928         va_start(args, pat);
1929         vwarner(err, pat, &args);
1930         va_end(args);
1931     }
1932 }
1933
1934 void
1935 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
1936 {
1937     PERL_ARGS_ASSERT_CK_WARNER;
1938
1939     if (Perl_ckwarn(aTHX_ err)) {
1940         va_list args;
1941         va_start(args, pat);
1942         vwarner(err, pat, &args);
1943         va_end(args);
1944     }
1945 }
1946
1947 void
1948 Perl_warner(pTHX_ U32  err, const char* pat,...)
1949 {
1950     va_list args;
1951     PERL_ARGS_ASSERT_WARNER;
1952     va_start(args, pat);
1953     vwarner(err, pat, &args);
1954     va_end(args);
1955 }
1956
1957 void
1958 Perl_vwarner(pTHX_ U32  err, const char* pat, va_list* args)
1959 {
1960     dVAR;
1961     PERL_ARGS_ASSERT_VWARNER;
1962     if (
1963         (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) &&
1964         !(PL_in_eval & EVAL_KEEPERR)
1965     ) {
1966         SV * const msv = vmess(pat, args);
1967
1968         if (PL_parser && PL_parser->error_count) {
1969             qerror(msv);
1970         }
1971         else {
1972             invoke_exception_hook(msv, FALSE);
1973             die_unwind(msv);
1974         }
1975     }
1976     else {
1977         Perl_vwarn(aTHX_ pat, args);
1978     }
1979 }
1980
1981 /* implements the ckWARN? macros */
1982
1983 bool
1984 Perl_ckwarn(pTHX_ U32 w)
1985 {
1986     /* If lexical warnings have not been set, use $^W.  */
1987     if (isLEXWARN_off)
1988         return PL_dowarn & G_WARN_ON;
1989
1990     return ckwarn_common(w);
1991 }
1992
1993 /* implements the ckWARN?_d macro */
1994
1995 bool
1996 Perl_ckwarn_d(pTHX_ U32 w)
1997 {
1998     /* If lexical warnings have not been set then default classes warn.  */
1999     if (isLEXWARN_off)
2000         return TRUE;
2001
2002     return ckwarn_common(w);
2003 }
2004
2005 static bool
2006 S_ckwarn_common(pTHX_ U32 w)
2007 {
2008     if (PL_curcop->cop_warnings == pWARN_ALL)
2009         return TRUE;
2010
2011     if (PL_curcop->cop_warnings == pWARN_NONE)
2012         return FALSE;
2013
2014     /* Check the assumption that at least the first slot is non-zero.  */
2015     assert(unpackWARN1(w));
2016
2017     /* Check the assumption that it is valid to stop as soon as a zero slot is
2018        seen.  */
2019     if (!unpackWARN2(w)) {
2020         assert(!unpackWARN3(w));
2021         assert(!unpackWARN4(w));
2022     } else if (!unpackWARN3(w)) {
2023         assert(!unpackWARN4(w));
2024     }
2025
2026     /* Right, dealt with all the special cases, which are implemented as non-
2027        pointers, so there is a pointer to a real warnings mask.  */
2028     do {
2029         if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
2030             return TRUE;
2031     } while (w >>= WARNshift);
2032
2033     return FALSE;
2034 }
2035
2036 /* Set buffer=NULL to get a new one.  */
2037 STRLEN *
2038 Perl_new_warnings_bitfield(pTHX_ STRLEN *buffer, const char *const bits,
2039                            STRLEN size) {
2040     const MEM_SIZE len_wanted =
2041         sizeof(STRLEN) + (size > WARNsize ? size : WARNsize);
2042     PERL_UNUSED_CONTEXT;
2043     PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
2044
2045     buffer = (STRLEN*)
2046         (specialWARN(buffer) ?
2047          PerlMemShared_malloc(len_wanted) :
2048          PerlMemShared_realloc(buffer, len_wanted));
2049     buffer[0] = size;
2050     Copy(bits, (buffer + 1), size, char);
2051     if (size < WARNsize)
2052         Zero((char *)(buffer + 1) + size, WARNsize - size, char);
2053     return buffer;
2054 }
2055
2056 /* since we've already done strlen() for both nam and val
2057  * we can use that info to make things faster than
2058  * sprintf(s, "%s=%s", nam, val)
2059  */
2060 #define my_setenv_format(s, nam, nlen, val, vlen) \
2061    Copy(nam, s, nlen, char); \
2062    *(s+nlen) = '='; \
2063    Copy(val, s+(nlen+1), vlen, char); \
2064    *(s+(nlen+1+vlen)) = '\0'
2065
2066 #ifdef USE_ENVIRON_ARRAY
2067        /* VMS' my_setenv() is in vms.c */
2068 #if !defined(WIN32) && !defined(NETWARE)
2069 void
2070 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2071 {
2072   dVAR;
2073 #ifdef __amigaos4__
2074   amigaos4_obtain_environ(__FUNCTION__);
2075 #endif
2076 #ifdef USE_ITHREADS
2077   /* only parent thread can modify process environment */
2078   if (PL_curinterp == aTHX)
2079 #endif
2080   {
2081 #ifndef PERL_USE_SAFE_PUTENV
2082     if (!PL_use_safe_putenv) {
2083         /* most putenv()s leak, so we manipulate environ directly */
2084         I32 i;
2085         const I32 len = strlen(nam);
2086         int nlen, vlen;
2087
2088         /* where does it go? */
2089         for (i = 0; environ[i]; i++) {
2090             if (strnEQ(environ[i],nam,len) && environ[i][len] == '=')
2091                 break;
2092         }
2093
2094         if (environ == PL_origenviron) {   /* need we copy environment? */
2095             I32 j;
2096             I32 max;
2097             char **tmpenv;
2098
2099             max = i;
2100             while (environ[max])
2101                 max++;
2102             tmpenv = (char**)safesysmalloc((max+2) * sizeof(char*));
2103             for (j=0; j<max; j++) {         /* copy environment */
2104                 const int len = strlen(environ[j]);
2105                 tmpenv[j] = (char*)safesysmalloc((len+1)*sizeof(char));
2106                 Copy(environ[j], tmpenv[j], len+1, char);
2107             }
2108             tmpenv[max] = NULL;
2109             environ = tmpenv;               /* tell exec where it is now */
2110         }
2111         if (!val) {
2112             safesysfree(environ[i]);
2113             while (environ[i]) {
2114                 environ[i] = environ[i+1];
2115                 i++;
2116             }
2117 #ifdef __amigaos4__
2118             goto my_setenv_out;
2119 #else
2120             return;
2121 #endif
2122         }
2123         if (!environ[i]) {                 /* does not exist yet */
2124             environ = (char**)safesysrealloc(environ, (i+2) * sizeof(char*));
2125             environ[i+1] = NULL;    /* make sure it's null terminated */
2126         }
2127         else
2128             safesysfree(environ[i]);
2129         nlen = strlen(nam);
2130         vlen = strlen(val);
2131
2132         environ[i] = (char*)safesysmalloc((nlen+vlen+2) * sizeof(char));
2133         /* all that work just for this */
2134         my_setenv_format(environ[i], nam, nlen, val, vlen);
2135     } else {
2136 # endif
2137     /* This next branch should only be called #if defined(HAS_SETENV), but
2138        Configure doesn't test for that yet.  For Solaris, setenv() and unsetenv()
2139        were introduced in Solaris 9, so testing for HAS UNSETENV is sufficient.
2140     */
2141 #   if defined(__CYGWIN__)|| defined(__SYMBIAN32__) || defined(__riscos__) || (defined(__sun) && defined(HAS_UNSETENV)) || defined(PERL_DARWIN)
2142 #       if defined(HAS_UNSETENV)
2143         if (val == NULL) {
2144             (void)unsetenv(nam);
2145         } else {
2146             (void)setenv(nam, val, 1);
2147         }
2148 #       else /* ! HAS_UNSETENV */
2149         (void)setenv(nam, val, 1);
2150 #       endif /* HAS_UNSETENV */
2151 #   else
2152 #       if defined(HAS_UNSETENV)
2153         if (val == NULL) {
2154             if (environ) /* old glibc can crash with null environ */
2155                 (void)unsetenv(nam);
2156         } else {
2157             const int nlen = strlen(nam);
2158             const int vlen = strlen(val);
2159             char * const new_env =
2160                 (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2161             my_setenv_format(new_env, nam, nlen, val, vlen);
2162             (void)putenv(new_env);
2163         }
2164 #       else /* ! HAS_UNSETENV */
2165         char *new_env;
2166         const int nlen = strlen(nam);
2167         int vlen;
2168         if (!val) {
2169            val = "";
2170         }
2171         vlen = strlen(val);
2172         new_env = (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2173         /* all that work just for this */
2174         my_setenv_format(new_env, nam, nlen, val, vlen);
2175         (void)putenv(new_env);
2176 #       endif /* HAS_UNSETENV */
2177 #   endif /* __CYGWIN__ */
2178 #ifndef PERL_USE_SAFE_PUTENV
2179     }
2180 #endif
2181   }
2182 #ifdef __amigaos4__
2183 my_setenv_out:
2184   amigaos4_release_environ(__FUNCTION__);
2185 #endif
2186 }
2187
2188 #else /* WIN32 || NETWARE */
2189
2190 void
2191 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2192 {
2193     dVAR;
2194     char *envstr;
2195     const int nlen = strlen(nam);
2196     int vlen;
2197
2198     if (!val) {
2199        val = "";
2200     }
2201     vlen = strlen(val);
2202     Newx(envstr, nlen+vlen+2, char);
2203     my_setenv_format(envstr, nam, nlen, val, vlen);
2204     (void)PerlEnv_putenv(envstr);
2205     Safefree(envstr);
2206 }
2207
2208 #endif /* WIN32 || NETWARE */
2209
2210 #endif /* !VMS */
2211
2212 #ifdef UNLINK_ALL_VERSIONS
2213 I32
2214 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
2215 {
2216     I32 retries = 0;
2217
2218     PERL_ARGS_ASSERT_UNLNK;
2219
2220     while (PerlLIO_unlink(f) >= 0)
2221         retries++;
2222     return retries ? 0 : -1;
2223 }
2224 #endif
2225
2226 /* this is a drop-in replacement for bcopy(), except for the return
2227  * value, which we need to be able to emulate memcpy()  */
2228 #if !defined(HAS_MEMCPY) || (!defined(HAS_MEMMOVE) && !defined(HAS_SAFE_MEMCPY))
2229 void *
2230 Perl_my_bcopy(const void *vfrom, void *vto, size_t len)
2231 {
2232 #if defined(HAS_BCOPY) && defined(HAS_SAFE_BCOPY)
2233     bcopy(vfrom, vto, len);
2234 #else
2235     const unsigned char *from = (const unsigned char *)vfrom;
2236     unsigned char *to = (unsigned char *)vto;
2237
2238     PERL_ARGS_ASSERT_MY_BCOPY;
2239
2240     if (from - to >= 0) {
2241         while (len--)
2242             *to++ = *from++;
2243     }
2244     else {
2245         to += len;
2246         from += len;
2247         while (len--)
2248             *(--to) = *(--from);
2249     }
2250 #endif
2251
2252     return vto;
2253 }
2254 #endif
2255
2256 /* this is a drop-in replacement for memset() */
2257 #ifndef HAS_MEMSET
2258 void *
2259 Perl_my_memset(void *vloc, int ch, size_t len)
2260 {
2261     unsigned char *loc = (unsigned char *)vloc;
2262
2263     PERL_ARGS_ASSERT_MY_MEMSET;
2264
2265     while (len--)
2266         *loc++ = ch;
2267     return vloc;
2268 }
2269 #endif
2270
2271 /* this is a drop-in replacement for bzero() */
2272 #if !defined(HAS_BZERO) && !defined(HAS_MEMSET)
2273 void *
2274 Perl_my_bzero(void *vloc, size_t len)
2275 {
2276     unsigned char *loc = (unsigned char *)vloc;
2277
2278     PERL_ARGS_ASSERT_MY_BZERO;
2279
2280     while (len--)
2281         *loc++ = 0;
2282     return vloc;
2283 }
2284 #endif
2285
2286 /* this is a drop-in replacement for memcmp() */
2287 #if !defined(HAS_MEMCMP) || !defined(HAS_SANE_MEMCMP)
2288 int
2289 Perl_my_memcmp(const void *vs1, const void *vs2, size_t len)
2290 {
2291     const U8 *a = (const U8 *)vs1;
2292     const U8 *b = (const U8 *)vs2;
2293     int tmp;
2294
2295     PERL_ARGS_ASSERT_MY_MEMCMP;
2296
2297     while (len--) {
2298         if ((tmp = *a++ - *b++))
2299             return tmp;
2300     }
2301     return 0;
2302 }
2303 #endif /* !HAS_MEMCMP || !HAS_SANE_MEMCMP */
2304
2305 #ifndef HAS_VPRINTF
2306 /* This vsprintf replacement should generally never get used, since
2307    vsprintf was available in both System V and BSD 2.11.  (There may
2308    be some cross-compilation or embedded set-ups where it is needed,
2309    however.)
2310
2311    If you encounter a problem in this function, it's probably a symptom
2312    that Configure failed to detect your system's vprintf() function.
2313    See the section on "item vsprintf" in the INSTALL file.
2314
2315    This version may compile on systems with BSD-ish <stdio.h>,
2316    but probably won't on others.
2317 */
2318
2319 #ifdef USE_CHAR_VSPRINTF
2320 char *
2321 #else
2322 int
2323 #endif
2324 vsprintf(char *dest, const char *pat, void *args)
2325 {
2326     FILE fakebuf;
2327
2328 #if defined(STDIO_PTR_LVALUE) && defined(STDIO_CNT_LVALUE)
2329     FILE_ptr(&fakebuf) = (STDCHAR *) dest;
2330     FILE_cnt(&fakebuf) = 32767;
2331 #else
2332     /* These probably won't compile -- If you really need
2333        this, you'll have to figure out some other method. */
2334     fakebuf._ptr = dest;
2335     fakebuf._cnt = 32767;
2336 #endif
2337 #ifndef _IOSTRG
2338 #define _IOSTRG 0
2339 #endif
2340     fakebuf._flag = _IOWRT|_IOSTRG;
2341     _doprnt(pat, args, &fakebuf);       /* what a kludge */
2342 #if defined(STDIO_PTR_LVALUE)
2343     *(FILE_ptr(&fakebuf)++) = '\0';
2344 #else
2345     /* PerlIO has probably #defined away fputc, but we want it here. */
2346 #  ifdef fputc
2347 #    undef fputc  /* XXX Should really restore it later */
2348 #  endif
2349     (void)fputc('\0', &fakebuf);
2350 #endif
2351 #ifdef USE_CHAR_VSPRINTF
2352     return(dest);
2353 #else
2354     return 0;           /* perl doesn't use return value */
2355 #endif
2356 }
2357
2358 #endif /* HAS_VPRINTF */
2359
2360 PerlIO *
2361 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2362 {
2363 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(OS2) && !defined(VMS) && !defined(NETWARE) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2364     int p[2];
2365     I32 This, that;
2366     Pid_t pid;
2367     SV *sv;
2368     I32 did_pipes = 0;
2369     int pp[2];
2370
2371     PERL_ARGS_ASSERT_MY_POPEN_LIST;
2372
2373     PERL_FLUSHALL_FOR_CHILD;
2374     This = (*mode == 'w');
2375     that = !This;
2376     if (TAINTING_get) {
2377         taint_env();
2378         taint_proper("Insecure %s%s", "EXEC");
2379     }
2380     if (PerlProc_pipe(p) < 0)
2381         return NULL;
2382     /* Try for another pipe pair for error return */
2383     if (PerlProc_pipe(pp) >= 0)
2384         did_pipes = 1;
2385     while ((pid = PerlProc_fork()) < 0) {
2386         if (errno != EAGAIN) {
2387             PerlLIO_close(p[This]);
2388             PerlLIO_close(p[that]);
2389             if (did_pipes) {
2390                 PerlLIO_close(pp[0]);
2391                 PerlLIO_close(pp[1]);
2392             }
2393             return NULL;
2394         }
2395         Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2396         sleep(5);
2397     }
2398     if (pid == 0) {
2399         /* Child */
2400 #undef THIS
2401 #undef THAT
2402 #define THIS that
2403 #define THAT This
2404         /* Close parent's end of error status pipe (if any) */
2405         if (did_pipes) {
2406             PerlLIO_close(pp[0]);
2407 #if defined(HAS_FCNTL) && defined(F_SETFD) && defined(FD_CLOEXEC)
2408             /* Close error pipe automatically if exec works */
2409             if (fcntl(pp[1], F_SETFD, FD_CLOEXEC) < 0)
2410                 return NULL;
2411 #endif
2412         }
2413         /* Now dup our end of _the_ pipe to right position */
2414         if (p[THIS] != (*mode == 'r')) {
2415             PerlLIO_dup2(p[THIS], *mode == 'r');
2416             PerlLIO_close(p[THIS]);
2417             if (p[THAT] != (*mode == 'r'))      /* if dup2() didn't close it */
2418                 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2419         }
2420         else
2421             PerlLIO_close(p[THAT]);     /* close parent's end of _the_ pipe */
2422 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2423         /* No automatic close - do it by hand */
2424 #  ifndef NOFILE
2425 #  define NOFILE 20
2426 #  endif
2427         {
2428             int fd;
2429
2430             for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2431                 if (fd != pp[1])
2432                     PerlLIO_close(fd);
2433             }
2434         }
2435 #endif
2436         do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2437         PerlProc__exit(1);
2438 #undef THIS
2439 #undef THAT
2440     }
2441     /* Parent */
2442     do_execfree();      /* free any memory malloced by child on fork */
2443     if (did_pipes)
2444         PerlLIO_close(pp[1]);
2445     /* Keep the lower of the two fd numbers */
2446     if (p[that] < p[This]) {
2447         PerlLIO_dup2(p[This], p[that]);
2448         PerlLIO_close(p[This]);
2449         p[This] = p[that];
2450     }
2451     else
2452         PerlLIO_close(p[that]);         /* close child's end of pipe */
2453
2454     sv = *av_fetch(PL_fdpid,p[This],TRUE);
2455     SvUPGRADE(sv,SVt_IV);
2456     SvIV_set(sv, pid);
2457     PL_forkprocess = pid;
2458     /* If we managed to get status pipe check for exec fail */
2459     if (did_pipes && pid > 0) {
2460         int errkid;
2461         unsigned n = 0;
2462
2463         while (n < sizeof(int)) {
2464             const SSize_t n1 = PerlLIO_read(pp[0],
2465                               (void*)(((char*)&errkid)+n),
2466                               (sizeof(int)) - n);
2467             if (n1 <= 0)
2468                 break;
2469             n += n1;
2470         }
2471         PerlLIO_close(pp[0]);
2472         did_pipes = 0;
2473         if (n) {                        /* Error */
2474             int pid2, status;
2475             PerlLIO_close(p[This]);
2476             if (n != sizeof(int))
2477                 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2478             do {
2479                 pid2 = wait4pid(pid, &status, 0);
2480             } while (pid2 == -1 && errno == EINTR);
2481             errno = errkid;             /* Propagate errno from kid */
2482             return NULL;
2483         }
2484     }
2485     if (did_pipes)
2486          PerlLIO_close(pp[0]);
2487     return PerlIO_fdopen(p[This], mode);
2488 #else
2489 #  if defined(OS2)      /* Same, without fork()ing and all extra overhead... */
2490     return my_syspopen4(aTHX_ NULL, mode, n, args);
2491 #  elif defined(WIN32)
2492     return win32_popenlist(mode, n, args);
2493 #  else
2494     Perl_croak(aTHX_ "List form of piped open not implemented");
2495     return (PerlIO *) NULL;
2496 #  endif
2497 #endif
2498 }
2499
2500     /* VMS' my_popen() is in VMS.c, same with OS/2 and AmigaOS 4. */
2501 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2502 PerlIO *
2503 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2504 {
2505     int p[2];
2506     I32 This, that;
2507     Pid_t pid;
2508     SV *sv;
2509     const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2510     I32 did_pipes = 0;
2511     int pp[2];
2512
2513     PERL_ARGS_ASSERT_MY_POPEN;
2514
2515     PERL_FLUSHALL_FOR_CHILD;
2516 #ifdef OS2
2517     if (doexec) {
2518         return my_syspopen(aTHX_ cmd,mode);
2519     }
2520 #endif
2521     This = (*mode == 'w');
2522     that = !This;
2523     if (doexec && TAINTING_get) {
2524         taint_env();
2525         taint_proper("Insecure %s%s", "EXEC");
2526     }
2527     if (PerlProc_pipe(p) < 0)
2528         return NULL;
2529     if (doexec && PerlProc_pipe(pp) >= 0)
2530         did_pipes = 1;
2531     while ((pid = PerlProc_fork()) < 0) {
2532         if (errno != EAGAIN) {
2533             PerlLIO_close(p[This]);
2534             PerlLIO_close(p[that]);
2535             if (did_pipes) {
2536                 PerlLIO_close(pp[0]);
2537                 PerlLIO_close(pp[1]);
2538             }
2539             if (!doexec)
2540                 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2541             return NULL;
2542         }
2543         Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2544         sleep(5);
2545     }
2546     if (pid == 0) {
2547
2548 #undef THIS
2549 #undef THAT
2550 #define THIS that
2551 #define THAT This
2552         if (did_pipes) {
2553             PerlLIO_close(pp[0]);
2554 #if defined(HAS_FCNTL) && defined(F_SETFD)
2555             if (fcntl(pp[1], F_SETFD, FD_CLOEXEC) < 0)
2556                 return NULL;
2557 #endif
2558         }
2559         if (p[THIS] != (*mode == 'r')) {
2560             PerlLIO_dup2(p[THIS], *mode == 'r');
2561             PerlLIO_close(p[THIS]);
2562             if (p[THAT] != (*mode == 'r'))      /* if dup2() didn't close it */
2563                 PerlLIO_close(p[THAT]);
2564         }
2565         else
2566             PerlLIO_close(p[THAT]);
2567 #ifndef OS2
2568         if (doexec) {
2569 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2570 #ifndef NOFILE
2571 #define NOFILE 20
2572 #endif
2573             {
2574                 int fd;
2575
2576                 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2577                     if (fd != pp[1])
2578                         PerlLIO_close(fd);
2579             }
2580 #endif
2581             /* may or may not use the shell */
2582             do_exec3(cmd, pp[1], did_pipes);
2583             PerlProc__exit(1);
2584         }
2585 #endif  /* defined OS2 */
2586
2587 #ifdef PERLIO_USING_CRLF
2588    /* Since we circumvent IO layers when we manipulate low-level
2589       filedescriptors directly, need to manually switch to the
2590       default, binary, low-level mode; see PerlIOBuf_open(). */
2591    PerlLIO_setmode((*mode == 'r'), O_BINARY);
2592 #endif
2593         PL_forkprocess = 0;
2594 #ifdef PERL_USES_PL_PIDSTATUS
2595         hv_clear(PL_pidstatus); /* we have no children */
2596 #endif
2597         return NULL;
2598 #undef THIS
2599 #undef THAT
2600     }
2601     do_execfree();      /* free any memory malloced by child on vfork */
2602     if (did_pipes)
2603         PerlLIO_close(pp[1]);
2604     if (p[that] < p[This]) {
2605         PerlLIO_dup2(p[This], p[that]);
2606         PerlLIO_close(p[This]);
2607         p[This] = p[that];
2608     }
2609     else
2610         PerlLIO_close(p[that]);
2611
2612     sv = *av_fetch(PL_fdpid,p[This],TRUE);
2613     SvUPGRADE(sv,SVt_IV);
2614     SvIV_set(sv, pid);
2615     PL_forkprocess = pid;
2616     if (did_pipes && pid > 0) {
2617         int errkid;
2618         unsigned n = 0;
2619
2620         while (n < sizeof(int)) {
2621             const SSize_t n1 = PerlLIO_read(pp[0],
2622                               (void*)(((char*)&errkid)+n),
2623                               (sizeof(int)) - n);
2624             if (n1 <= 0)
2625                 break;
2626             n += n1;
2627         }
2628         PerlLIO_close(pp[0]);
2629         did_pipes = 0;
2630         if (n) {                        /* Error */
2631             int pid2, status;
2632             PerlLIO_close(p[This]);
2633             if (n != sizeof(int))
2634                 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2635             do {
2636                 pid2 = wait4pid(pid, &status, 0);
2637             } while (pid2 == -1 && errno == EINTR);
2638             errno = errkid;             /* Propagate errno from kid */
2639             return NULL;
2640         }
2641     }
2642     if (did_pipes)
2643          PerlLIO_close(pp[0]);
2644     return PerlIO_fdopen(p[This], mode);
2645 }
2646 #else
2647 #if defined(DJGPP)
2648 FILE *djgpp_popen();
2649 PerlIO *
2650 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2651 {
2652     PERL_FLUSHALL_FOR_CHILD;
2653     /* Call system's popen() to get a FILE *, then import it.
2654        used 0 for 2nd parameter to PerlIO_importFILE;
2655        apparently not used
2656     */
2657     return PerlIO_importFILE(djgpp_popen(cmd, mode), 0);
2658 }
2659 #else
2660 #if defined(__LIBCATAMOUNT__)
2661 PerlIO *
2662 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2663 {
2664     return NULL;
2665 }
2666 #endif
2667 #endif
2668
2669 #endif /* !DOSISH */
2670
2671 /* this is called in parent before the fork() */
2672 void
2673 Perl_atfork_lock(void)
2674 #if defined(USE_ITHREADS)
2675 #  ifdef USE_PERLIO
2676   PERL_TSA_ACQUIRE(PL_perlio_mutex)
2677 #  endif
2678 #  ifdef MYMALLOC
2679   PERL_TSA_ACQUIRE(PL_malloc_mutex)
2680 #  endif
2681   PERL_TSA_ACQUIRE(PL_op_mutex)
2682 #endif
2683 {
2684 #if defined(USE_ITHREADS)
2685     dVAR;
2686     /* locks must be held in locking order (if any) */
2687 #  ifdef USE_PERLIO
2688     MUTEX_LOCK(&PL_perlio_mutex);
2689 #  endif
2690 #  ifdef MYMALLOC
2691     MUTEX_LOCK(&PL_malloc_mutex);
2692 #  endif
2693     OP_REFCNT_LOCK;
2694 #endif
2695 }
2696
2697 /* this is called in both parent and child after the fork() */
2698 void
2699 Perl_atfork_unlock(void)
2700 #if defined(USE_ITHREADS)
2701 #  ifdef USE_PERLIO
2702   PERL_TSA_RELEASE(PL_perlio_mutex)
2703 #  endif
2704 #  ifdef MYMALLOC
2705   PERL_TSA_RELEASE(PL_malloc_mutex)
2706 #  endif
2707   PERL_TSA_RELEASE(PL_op_mutex)
2708 #endif
2709 {
2710 #if defined(USE_ITHREADS)
2711     dVAR;
2712     /* locks must be released in same order as in atfork_lock() */
2713 #  ifdef USE_PERLIO
2714     MUTEX_UNLOCK(&PL_perlio_mutex);
2715 #  endif
2716 #  ifdef MYMALLOC
2717     MUTEX_UNLOCK(&PL_malloc_mutex);
2718 #  endif
2719     OP_REFCNT_UNLOCK;
2720 #endif
2721 }
2722
2723 Pid_t
2724 Perl_my_fork(void)
2725 {
2726 #if defined(HAS_FORK)
2727     Pid_t pid;
2728 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2729     atfork_lock();
2730     pid = fork();
2731     atfork_unlock();
2732 #else
2733     /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2734      * handlers elsewhere in the code */
2735     pid = fork();
2736 #endif
2737     return pid;
2738 #elif defined(__amigaos4__)
2739     return amigaos_fork();
2740 #else
2741     /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2742     Perl_croak_nocontext("fork() not available");
2743     return 0;
2744 #endif /* HAS_FORK */
2745 }
2746
2747 #ifndef HAS_DUP2
2748 int
2749 dup2(int oldfd, int newfd)
2750 {
2751 #if defined(HAS_FCNTL) && defined(F_DUPFD)
2752     if (oldfd == newfd)
2753         return oldfd;
2754     PerlLIO_close(newfd);
2755     return fcntl(oldfd, F_DUPFD, newfd);
2756 #else
2757 #define DUP2_MAX_FDS 256
2758     int fdtmp[DUP2_MAX_FDS];
2759     I32 fdx = 0;
2760     int fd;
2761
2762     if (oldfd == newfd)
2763         return oldfd;
2764     PerlLIO_close(newfd);
2765     /* good enough for low fd's... */
2766     while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
2767         if (fdx >= DUP2_MAX_FDS) {
2768             PerlLIO_close(fd);
2769             fd = -1;
2770             break;
2771         }
2772         fdtmp[fdx++] = fd;
2773     }
2774     while (fdx > 0)
2775         PerlLIO_close(fdtmp[--fdx]);
2776     return fd;
2777 #endif
2778 }
2779 #endif
2780
2781 #ifndef PERL_MICRO
2782 #ifdef HAS_SIGACTION
2783
2784 Sighandler_t
2785 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2786 {
2787     struct sigaction act, oact;
2788
2789 #ifdef USE_ITHREADS
2790     dVAR;
2791     /* only "parent" interpreter can diddle signals */
2792     if (PL_curinterp != aTHX)
2793         return (Sighandler_t) SIG_ERR;
2794 #endif
2795
2796     act.sa_handler = (void(*)(int))handler;
2797     sigemptyset(&act.sa_mask);
2798     act.sa_flags = 0;
2799 #ifdef SA_RESTART
2800     if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2801         act.sa_flags |= SA_RESTART;     /* SVR4, 4.3+BSD */
2802 #endif
2803 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2804     if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2805         act.sa_flags |= SA_NOCLDWAIT;
2806 #endif
2807     if (sigaction(signo, &act, &oact) == -1)
2808         return (Sighandler_t) SIG_ERR;
2809     else
2810         return (Sighandler_t) oact.sa_handler;
2811 }
2812
2813 Sighandler_t
2814 Perl_rsignal_state(pTHX_ int signo)
2815 {
2816     struct sigaction oact;
2817     PERL_UNUSED_CONTEXT;
2818
2819     if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
2820         return (Sighandler_t) SIG_ERR;
2821     else
2822         return (Sighandler_t) oact.sa_handler;
2823 }
2824
2825 int
2826 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2827 {
2828 #ifdef USE_ITHREADS
2829     dVAR;
2830 #endif
2831     struct sigaction act;
2832
2833     PERL_ARGS_ASSERT_RSIGNAL_SAVE;
2834
2835 #ifdef USE_ITHREADS
2836     /* only "parent" interpreter can diddle signals */
2837     if (PL_curinterp != aTHX)
2838         return -1;
2839 #endif
2840
2841     act.sa_handler = (void(*)(int))handler;
2842     sigemptyset(&act.sa_mask);
2843     act.sa_flags = 0;
2844 #ifdef SA_RESTART
2845     if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2846         act.sa_flags |= SA_RESTART;     /* SVR4, 4.3+BSD */
2847 #endif
2848 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2849     if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2850         act.sa_flags |= SA_NOCLDWAIT;
2851 #endif
2852     return sigaction(signo, &act, save);
2853 }
2854
2855 int
2856 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2857 {
2858 #ifdef USE_ITHREADS
2859     dVAR;
2860 #endif
2861     PERL_UNUSED_CONTEXT;
2862 #ifdef USE_ITHREADS
2863     /* only "parent" interpreter can diddle signals */
2864     if (PL_curinterp != aTHX)
2865         return -1;
2866 #endif
2867
2868     return sigaction(signo, save, (struct sigaction *)NULL);
2869 }
2870
2871 #else /* !HAS_SIGACTION */
2872
2873 Sighandler_t
2874 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2875 {
2876 #if defined(USE_ITHREADS) && !defined(WIN32)
2877     /* only "parent" interpreter can diddle signals */
2878     if (PL_curinterp != aTHX)
2879         return (Sighandler_t) SIG_ERR;
2880 #endif
2881
2882     return PerlProc_signal(signo, handler);
2883 }
2884
2885 static Signal_t
2886 sig_trap(int signo)
2887 {
2888     dVAR;
2889     PL_sig_trapped++;
2890 }
2891
2892 Sighandler_t
2893 Perl_rsignal_state(pTHX_ int signo)
2894 {
2895     dVAR;
2896     Sighandler_t oldsig;
2897
2898 #if defined(USE_ITHREADS) && !defined(WIN32)
2899     /* only "parent" interpreter can diddle signals */
2900     if (PL_curinterp != aTHX)
2901         return (Sighandler_t) SIG_ERR;
2902 #endif
2903
2904     PL_sig_trapped = 0;
2905     oldsig = PerlProc_signal(signo, sig_trap);
2906     PerlProc_signal(signo, oldsig);
2907     if (PL_sig_trapped)
2908         PerlProc_kill(PerlProc_getpid(), signo);
2909     return oldsig;
2910 }
2911
2912 int
2913 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2914 {
2915 #if defined(USE_ITHREADS) && !defined(WIN32)
2916     /* only "parent" interpreter can diddle signals */
2917     if (PL_curinterp != aTHX)
2918         return -1;
2919 #endif
2920     *save = PerlProc_signal(signo, handler);
2921     return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
2922 }
2923
2924 int
2925 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2926 {
2927 #if defined(USE_ITHREADS) && !defined(WIN32)
2928     /* only "parent" interpreter can diddle signals */
2929     if (PL_curinterp != aTHX)
2930         return -1;
2931 #endif
2932     return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
2933 }
2934
2935 #endif /* !HAS_SIGACTION */
2936 #endif /* !PERL_MICRO */
2937
2938     /* VMS' my_pclose() is in VMS.c; same with OS/2 */
2939 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2940 I32
2941 Perl_my_pclose(pTHX_ PerlIO *ptr)
2942 {
2943     int status;
2944     SV **svp;
2945     Pid_t pid;
2946     Pid_t pid2 = 0;
2947     bool close_failed;
2948     dSAVEDERRNO;
2949     const int fd = PerlIO_fileno(ptr);
2950     bool should_wait;
2951
2952     svp = av_fetch(PL_fdpid,fd,TRUE);
2953     pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
2954     SvREFCNT_dec(*svp);
2955     *svp = NULL;
2956
2957 #if defined(USE_PERLIO)
2958     /* Find out whether the refcount is low enough for us to wait for the
2959        child proc without blocking. */
2960     should_wait = PerlIOUnix_refcnt(fd) == 1 && pid > 0;
2961 #else
2962     should_wait = pid > 0;
2963 #endif
2964
2965 #ifdef OS2
2966     if (pid == -1) {                    /* Opened by popen. */
2967         return my_syspclose(ptr);
2968     }
2969 #endif
2970     close_failed = (PerlIO_close(ptr) == EOF);
2971     SAVE_ERRNO;
2972     if (should_wait) do {
2973         pid2 = wait4pid(pid, &status, 0);
2974     } while (pid2 == -1 && errno == EINTR);
2975     if (close_failed) {
2976         RESTORE_ERRNO;
2977         return -1;
2978     }
2979     return(
2980       should_wait
2981        ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
2982        : 0
2983     );
2984 }
2985 #else
2986 #if defined(__LIBCATAMOUNT__)
2987 I32
2988 Perl_my_pclose(pTHX_ PerlIO *ptr)
2989 {
2990     return -1;
2991 }
2992 #endif
2993 #endif /* !DOSISH */
2994
2995 #if  (!defined(DOSISH) || defined(OS2) || defined(WIN32) || defined(NETWARE)) && !defined(__LIBCATAMOUNT__)
2996 I32
2997 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
2998 {
2999     I32 result = 0;
3000     PERL_ARGS_ASSERT_WAIT4PID;
3001 #ifdef PERL_USES_PL_PIDSTATUS
3002     if (!pid) {
3003         /* PERL_USES_PL_PIDSTATUS is only defined when neither
3004            waitpid() nor wait4() is available, or on OS/2, which
3005            doesn't appear to support waiting for a progress group
3006            member, so we can only treat a 0 pid as an unknown child.
3007         */
3008         errno = ECHILD;
3009         return -1;
3010     }
3011     {
3012         if (pid > 0) {
3013             /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
3014                pid, rather than a string form.  */
3015             SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
3016             if (svp && *svp != &PL_sv_undef) {
3017                 *statusp = SvIVX(*svp);
3018                 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
3019                                 G_DISCARD);
3020                 return pid;
3021             }
3022         }
3023         else {
3024             HE *entry;
3025
3026             hv_iterinit(PL_pidstatus);
3027             if ((entry = hv_iternext(PL_pidstatus))) {
3028                 SV * const sv = hv_iterval(PL_pidstatus,entry);
3029                 I32 len;
3030                 const char * const spid = hv_iterkey(entry,&len);
3031
3032                 assert (len == sizeof(Pid_t));
3033                 memcpy((char *)&pid, spid, len);
3034                 *statusp = SvIVX(sv);
3035                 /* The hash iterator is currently on this entry, so simply
3036                    calling hv_delete would trigger the lazy delete, which on
3037                    aggregate does more work, because next call to hv_iterinit()
3038                    would spot the flag, and have to call the delete routine,
3039                    while in the meantime any new entries can't re-use that
3040                    memory.  */
3041                 hv_iterinit(PL_pidstatus);
3042                 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
3043                 return pid;
3044             }
3045         }
3046     }
3047 #endif
3048 #ifdef HAS_WAITPID
3049 #  ifdef HAS_WAITPID_RUNTIME
3050     if (!HAS_WAITPID_RUNTIME)
3051         goto hard_way;
3052 #  endif
3053     result = PerlProc_waitpid(pid,statusp,flags);
3054     goto finish;
3055 #endif
3056 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
3057     result = wait4(pid,statusp,flags,NULL);
3058     goto finish;
3059 #endif
3060 #ifdef PERL_USES_PL_PIDSTATUS
3061 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
3062   hard_way:
3063 #endif
3064     {
3065         if (flags)
3066             Perl_croak(aTHX_ "Can't do waitpid with flags");
3067         else {
3068             while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
3069                 pidgone(result,*statusp);
3070             if (result < 0)
3071                 *statusp = -1;
3072         }
3073     }
3074 #endif
3075 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
3076   finish:
3077 #endif
3078     if (result < 0 && errno == EINTR) {
3079         PERL_ASYNC_CHECK();
3080         errno = EINTR; /* reset in case a signal handler changed $! */
3081     }
3082     return result;
3083 }
3084 #endif /* !DOSISH || OS2 || WIN32 || NETWARE */
3085
3086 #ifdef PERL_USES_PL_PIDSTATUS
3087 void
3088 S_pidgone(pTHX_ Pid_t pid, int status)
3089 {
3090     SV *sv;
3091
3092     sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
3093     SvUPGRADE(sv,SVt_IV);
3094     SvIV_set(sv, status);
3095     return;
3096 }
3097 #endif
3098
3099 #if defined(OS2)
3100 int pclose();
3101 #ifdef HAS_FORK
3102 int                                     /* Cannot prototype with I32
3103                                            in os2ish.h. */
3104 my_syspclose(PerlIO *ptr)
3105 #else
3106 I32
3107 Perl_my_pclose(pTHX_ PerlIO *ptr)
3108 #endif
3109 {
3110     /* Needs work for PerlIO ! */
3111     FILE * const f = PerlIO_findFILE(ptr);
3112     const I32 result = pclose(f);
3113     PerlIO_releaseFILE(ptr,f);
3114     return result;
3115 }
3116 #endif
3117
3118 #if defined(DJGPP)
3119 int djgpp_pclose();
3120 I32
3121 Perl_my_pclose(pTHX_ PerlIO *ptr)
3122 {
3123     /* Needs work for PerlIO ! */
3124     FILE * const f = PerlIO_findFILE(ptr);
3125     I32 result = djgpp_pclose(f);
3126     result = (result << 8) & 0xff00;
3127     PerlIO_releaseFILE(ptr,f);
3128     return result;
3129 }
3130 #endif
3131
3132 #define PERL_REPEATCPY_LINEAR 4
3133 void
3134 Perl_repeatcpy(char *to, const char *from, I32 len, IV count)
3135 {
3136     PERL_ARGS_ASSERT_REPEATCPY;
3137
3138     assert(len >= 0);
3139
3140     if (count < 0)
3141         croak_memory_wrap();
3142
3143     if (len == 1)
3144         memset(to, *from, count);
3145     else if (count) {
3146         char *p = to;
3147         IV items, linear, half;
3148
3149         linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
3150         for (items = 0; items < linear; ++items) {
3151             const char *q = from;
3152             IV todo;
3153             for (todo = len; todo > 0; todo--)
3154                 *p++ = *q++;
3155         }
3156
3157         half = count / 2;
3158         while (items <= half) {
3159             IV size = items * len;
3160             memcpy(p, to, size);
3161             p     += size;
3162             items *= 2;
3163         }
3164
3165         if (count > items)
3166             memcpy(p, to, (count - items) * len);
3167     }
3168 }
3169
3170 #ifndef HAS_RENAME
3171 I32
3172 Perl_same_dirent(pTHX_ const char *a, const char *b)
3173 {
3174     char *fa = strrchr(a,'/');
3175     char *fb = strrchr(b,'/');
3176     Stat_t tmpstatbuf1;
3177     Stat_t tmpstatbuf2;
3178     SV * const tmpsv = sv_newmortal();
3179
3180     PERL_ARGS_ASSERT_SAME_DIRENT;
3181
3182     if (fa)
3183         fa++;
3184     else
3185         fa = a;
3186     if (fb)
3187         fb++;
3188     else
3189         fb = b;
3190     if (strNE(a,b))
3191         return FALSE;
3192     if (fa == a)
3193         sv_setpvs(tmpsv, ".");
3194     else
3195         sv_setpvn(tmpsv, a, fa - a);
3196     if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
3197         return FALSE;
3198     if (fb == b)
3199         sv_setpvs(tmpsv, ".");
3200     else
3201         sv_setpvn(tmpsv, b, fb - b);
3202     if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
3203         return FALSE;
3204     return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3205            tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3206 }
3207 #endif /* !HAS_RENAME */
3208
3209 char*
3210 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3211                  const char *const *const search_ext, I32 flags)
3212 {
3213     const char *xfound = NULL;
3214     char *xfailed = NULL;
3215     char tmpbuf[MAXPATHLEN];
3216     char *s;
3217     I32 len = 0;
3218     int retval;
3219     char *bufend;
3220 #if defined(DOSISH) && !defined(OS2)
3221 #  define SEARCH_EXTS ".bat", ".cmd", NULL
3222 #  define MAX_EXT_LEN 4
3223 #endif
3224 #ifdef OS2
3225 #  define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3226 #  define MAX_EXT_LEN 4
3227 #endif
3228 #ifdef VMS
3229 #  define SEARCH_EXTS ".pl", ".com", NULL
3230 #  define MAX_EXT_LEN 4
3231 #endif
3232     /* additional extensions to try in each dir if scriptname not found */
3233 #ifdef SEARCH_EXTS
3234     static const char *const exts[] = { SEARCH_EXTS };
3235     const char *const *const ext = search_ext ? search_ext : exts;
3236     int extidx = 0, i = 0;
3237     const char *curext = NULL;
3238 #else
3239     PERL_UNUSED_ARG(search_ext);
3240 #  define MAX_EXT_LEN 0
3241 #endif
3242
3243     PERL_ARGS_ASSERT_FIND_SCRIPT;
3244
3245     /*
3246      * If dosearch is true and if scriptname does not contain path
3247      * delimiters, search the PATH for scriptname.
3248      *
3249      * If SEARCH_EXTS is also defined, will look for each
3250      * scriptname{SEARCH_EXTS} whenever scriptname is not found
3251      * while searching the PATH.
3252      *
3253      * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3254      * proceeds as follows:
3255      *   If DOSISH or VMSISH:
3256      *     + look for ./scriptname{,.foo,.bar}
3257      *     + search the PATH for scriptname{,.foo,.bar}
3258      *
3259      *   If !DOSISH:
3260      *     + look *only* in the PATH for scriptname{,.foo,.bar} (note
3261      *       this will not look in '.' if it's not in the PATH)
3262      */
3263     tmpbuf[0] = '\0';
3264
3265 #ifdef VMS
3266 #  ifdef ALWAYS_DEFTYPES
3267     len = strlen(scriptname);
3268     if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3269         int idx = 0, deftypes = 1;
3270         bool seen_dot = 1;
3271
3272         const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3273 #  else
3274     if (dosearch) {
3275         int idx = 0, deftypes = 1;
3276         bool seen_dot = 1;
3277
3278         const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3279 #  endif
3280         /* The first time through, just add SEARCH_EXTS to whatever we
3281          * already have, so we can check for default file types. */
3282         while (deftypes ||
3283                (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3284         {
3285             Stat_t statbuf;
3286             if (deftypes) {
3287                 deftypes = 0;
3288                 *tmpbuf = '\0';
3289             }
3290             if ((strlen(tmpbuf) + strlen(scriptname)
3291                  + MAX_EXT_LEN) >= sizeof tmpbuf)
3292                 continue;       /* don't search dir with too-long name */
3293             my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3294 #else  /* !VMS */
3295
3296 #ifdef DOSISH
3297     if (strEQ(scriptname, "-"))
3298         dosearch = 0;
3299     if (dosearch) {             /* Look in '.' first. */
3300         const char *cur = scriptname;
3301 #ifdef SEARCH_EXTS
3302         if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3303             while (ext[i])
3304                 if (strEQ(ext[i++],curext)) {
3305                     extidx = -1;                /* already has an ext */
3306                     break;
3307                 }
3308         do {
3309 #endif
3310             DEBUG_p(PerlIO_printf(Perl_debug_log,
3311                                   "Looking for %s\n",cur));
3312             {
3313                 Stat_t statbuf;
3314                 if (PerlLIO_stat(cur,&statbuf) >= 0
3315                     && !S_ISDIR(statbuf.st_mode)) {
3316                     dosearch = 0;
3317                     scriptname = cur;
3318 #ifdef SEARCH_EXTS
3319                     break;
3320 #endif
3321                 }
3322             }
3323 #ifdef SEARCH_EXTS
3324             if (cur == scriptname) {
3325                 len = strlen(scriptname);
3326                 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3327                     break;
3328                 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3329                 cur = tmpbuf;
3330             }
3331         } while (extidx >= 0 && ext[extidx]     /* try an extension? */
3332                  && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3333 #endif
3334     }
3335 #endif
3336
3337     if (dosearch && !strchr(scriptname, '/')
3338 #ifdef DOSISH
3339                  && !strchr(scriptname, '\\')
3340 #endif
3341                  && (s = PerlEnv_getenv("PATH")))
3342     {
3343         bool seen_dot = 0;
3344
3345         bufend = s + strlen(s);
3346         while (s < bufend) {
3347             Stat_t statbuf;
3348 #  ifdef DOSISH
3349             for (len = 0; *s
3350                     && *s != ';'; len++, s++) {
3351                 if (len < sizeof tmpbuf)
3352                     tmpbuf[len] = *s;
3353             }
3354             if (len < sizeof tmpbuf)
3355                 tmpbuf[len] = '\0';
3356 #  else
3357             s = delimcpy_no_escape(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3358                                    ':', &len);
3359 #  endif
3360             if (s < bufend)
3361                 s++;
3362             if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3363                 continue;       /* don't search dir with too-long name */
3364             if (len
3365 #  ifdef DOSISH
3366                 && tmpbuf[len - 1] != '/'
3367                 && tmpbuf[len - 1] != '\\'
3368 #  endif
3369                )
3370                 tmpbuf[len++] = '/';
3371             if (len == 2 && tmpbuf[0] == '.')
3372                 seen_dot = 1;
3373             (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3374 #endif  /* !VMS */
3375
3376 #ifdef SEARCH_EXTS
3377             len = strlen(tmpbuf);
3378             if (extidx > 0)     /* reset after previous loop */
3379                 extidx = 0;
3380             do {
3381 #endif
3382                 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3383                 retval = PerlLIO_stat(tmpbuf,&statbuf);
3384                 if (S_ISDIR(statbuf.st_mode)) {
3385                     retval = -1;
3386                 }
3387 #ifdef SEARCH_EXTS
3388             } while (  retval < 0               /* not there */
3389                     && extidx>=0 && ext[extidx] /* try an extension? */
3390                     && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3391                 );
3392 #endif
3393             if (retval < 0)
3394                 continue;
3395             if (S_ISREG(statbuf.st_mode)
3396                 && cando(S_IRUSR,TRUE,&statbuf)
3397 #if !defined(DOSISH)
3398                 && cando(S_IXUSR,TRUE,&statbuf)
3399 #endif
3400                 )
3401             {
3402                 xfound = tmpbuf;                /* bingo! */
3403                 break;
3404             }
3405             if (!xfailed)
3406                 xfailed = savepv(tmpbuf);
3407         }
3408 #ifndef DOSISH
3409         {
3410             Stat_t statbuf;
3411             if (!xfound && !seen_dot && !xfailed &&
3412                 (PerlLIO_stat(scriptname,&statbuf) < 0
3413                  || S_ISDIR(statbuf.st_mode)))
3414 #endif
3415                 seen_dot = 1;                   /* Disable message. */
3416 #ifndef DOSISH
3417         }
3418 #endif
3419         if (!xfound) {
3420             if (flags & 1) {                    /* do or die? */
3421                 /* diag_listed_as: Can't execute %s */
3422                 Perl_croak(aTHX_ "Can't %s %s%s%s",
3423                       (xfailed ? "execute" : "find"),
3424                       (xfailed ? xfailed : scriptname),
3425                       (xfailed ? "" : " on PATH"),
3426                       (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3427             }
3428             scriptname = NULL;
3429         }
3430         Safefree(xfailed);
3431         scriptname = xfound;
3432     }
3433     return (scriptname ? savepv(scriptname) : NULL);
3434 }
3435
3436 #ifndef PERL_GET_CONTEXT_DEFINED
3437
3438 void *
3439 Perl_get_context(void)
3440 {
3441 #if defined(USE_ITHREADS)
3442     dVAR;
3443 #  ifdef OLD_PTHREADS_API
3444     pthread_addr_t t;
3445     int error = pthread_getspecific(PL_thr_key, &t)
3446     if (error)
3447         Perl_croak_nocontext("panic: pthread_getspecific, error=%d", error);
3448     return (void*)t;
3449 #  else
3450 #    ifdef I_MACH_CTHREADS
3451     return (void*)cthread_data(cthread_self());
3452 #    else
3453     return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
3454 #    endif
3455 #  endif
3456 #else
3457     return (void*)NULL;
3458 #endif
3459 }
3460
3461 void
3462 Perl_set_context(void *t)
3463 {
3464 #if defined(USE_ITHREADS)
3465     dVAR;
3466 #endif
3467     PERL_ARGS_ASSERT_SET_CONTEXT;
3468 #if defined(USE_ITHREADS)
3469 #  ifdef I_MACH_CTHREADS
3470     cthread_set_data(cthread_self(), t);
3471 #  else
3472     {
3473         const int error = pthread_setspecific(PL_thr_key, t);
3474         if (error)
3475             Perl_croak_nocontext("panic: pthread_setspecific, error=%d", error);
3476     }
3477 #  endif
3478 #else
3479     PERL_UNUSED_ARG(t);
3480 #endif
3481 }
3482
3483 #endif /* !PERL_GET_CONTEXT_DEFINED */
3484
3485 #if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
3486 struct perl_vars *
3487 Perl_GetVars(pTHX)
3488 {
3489     PERL_UNUSED_CONTEXT;
3490     return &PL_Vars;
3491 }
3492 #endif
3493
3494 char **
3495 Perl_get_op_names(pTHX)
3496 {
3497     PERL_UNUSED_CONTEXT;
3498     return (char **)PL_op_name;
3499 }
3500
3501 char **
3502 Perl_get_op_descs(pTHX)
3503 {
3504     PERL_UNUSED_CONTEXT;
3505     return (char **)PL_op_desc;
3506 }
3507
3508 const char *
3509 Perl_get_no_modify(pTHX)
3510 {
3511     PERL_UNUSED_CONTEXT;
3512     return PL_no_modify;
3513 }
3514
3515 U32 *
3516 Perl_get_opargs(pTHX)
3517 {
3518     PERL_UNUSED_CONTEXT;
3519     return (U32 *)PL_opargs;
3520 }
3521
3522 PPADDR_t*
3523 Perl_get_ppaddr(pTHX)
3524 {
3525     dVAR;
3526     PERL_UNUSED_CONTEXT;
3527     return (PPADDR_t*)PL_ppaddr;
3528 }
3529
3530 #ifndef HAS_GETENV_LEN
3531 char *
3532 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3533 {
3534     char * const env_trans = PerlEnv_getenv(env_elem);
3535     PERL_UNUSED_CONTEXT;
3536     PERL_ARGS_ASSERT_GETENV_LEN;
3537     if (env_trans)
3538         *len = strlen(env_trans);
3539     return env_trans;
3540 }
3541 #endif
3542
3543
3544 MGVTBL*
3545 Perl_get_vtbl(pTHX_ int vtbl_id)
3546 {
3547     PERL_UNUSED_CONTEXT;
3548
3549     return (vtbl_id < 0 || vtbl_id >= magic_vtable_max)
3550         ? NULL : (MGVTBL*)PL_magic_vtables + vtbl_id;
3551 }
3552
3553 I32
3554 Perl_my_fflush_all(pTHX)
3555 {
3556 #if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3557     return PerlIO_flush(NULL);
3558 #else
3559 # if defined(HAS__FWALK)
3560     extern int fflush(FILE *);
3561     /* undocumented, unprototyped, but very useful BSDism */
3562     extern void _fwalk(int (*)(FILE *));
3563     _fwalk(&fflush);
3564     return 0;
3565 # else
3566 #  if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3567     long open_max = -1;
3568 #   ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3569     open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3570 #   else
3571 #    if defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3572     open_max = sysconf(_SC_OPEN_MAX);
3573 #     else
3574 #      ifdef FOPEN_MAX
3575     open_max = FOPEN_MAX;
3576 #      else
3577 #       ifdef OPEN_MAX
3578     open_max = OPEN_MAX;
3579 #       else
3580 #        ifdef _NFILE
3581     open_max = _NFILE;
3582 #        endif
3583 #       endif
3584 #      endif
3585 #     endif
3586 #    endif
3587     if (open_max > 0) {
3588       long i;
3589       for (i = 0; i < open_max; i++)
3590             if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3591                 STDIO_STREAM_ARRAY[i]._file < open_max &&
3592                 STDIO_STREAM_ARRAY[i]._flag)
3593                 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3594       return 0;
3595     }
3596 #  endif
3597     SETERRNO(EBADF,RMS_IFI);
3598     return EOF;
3599 # endif
3600 #endif
3601 }
3602
3603 void
3604 Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
3605 {
3606     if (ckWARN(WARN_IO)) {
3607         HEK * const name
3608            = gv && (isGV_with_GP(gv))
3609                 ? GvENAME_HEK((gv))
3610                 : NULL;
3611         const char * const direction = have == '>' ? "out" : "in";
3612
3613         if (name && HEK_LEN(name))
3614             Perl_warner(aTHX_ packWARN(WARN_IO),
3615                         "Filehandle %" HEKf " opened only for %sput",
3616                         HEKfARG(name), direction);
3617         else
3618             Perl_warner(aTHX_ packWARN(WARN_IO),
3619                         "Filehandle opened only for %sput", direction);
3620     }
3621 }
3622
3623 void
3624 Perl_report_evil_fh(pTHX_ const GV *gv)
3625 {
3626     const IO *io = gv ? GvIO(gv) : NULL;
3627     const PERL_BITFIELD16 op = PL_op->op_type;
3628     const char *vile;
3629     I32 warn_type;
3630
3631     if (io && IoTYPE(io) == IoTYPE_CLOSED) {
3632         vile = "closed";
3633         warn_type = WARN_CLOSED;
3634     }
3635     else {
3636         vile = "unopened";
3637         warn_type = WARN_UNOPENED;
3638     }
3639
3640     if (ckWARN(warn_type)) {
3641         SV * const name
3642             = gv && isGV_with_GP(gv) && GvENAMELEN(gv) ?
3643                                      sv_2mortal(newSVhek(GvENAME_HEK(gv))) : NULL;
3644         const char * const pars =
3645             (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3646         const char * const func =
3647             (const char *)
3648             (op == OP_READLINE || op == OP_RCATLINE
3649                                  ? "readline"  :        /* "<HANDLE>" not nice */
3650              op == OP_LEAVEWRITE ? "write" :            /* "write exit" not nice */
3651              PL_op_desc[op]);
3652         const char * const type =
3653             (const char *)
3654             (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
3655              ? "socket" : "filehandle");
3656         const bool have_name = name && SvCUR(name);
3657         Perl_warner(aTHX_ packWARN(warn_type),
3658                    "%s%s on %s %s%s%" SVf, func, pars, vile, type,
3659                     have_name ? " " : "",
3660                     SVfARG(have_name ? name : &PL_sv_no));
3661         if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3662                 Perl_warner(
3663                             aTHX_ packWARN(warn_type),
3664                         "\t(Are you trying to call %s%s on dirhandle%s%" SVf "?)\n",
3665                         func, pars, have_name ? " " : "",
3666                         SVfARG(have_name ? name : &PL_sv_no)
3667                             );
3668     }
3669 }
3670
3671 /* To workaround core dumps from the uninitialised tm_zone we get the
3672  * system to give us a reasonable struct to copy.  This fix means that
3673  * strftime uses the tm_zone and tm_gmtoff values returned by
3674  * localtime(time()). That should give the desired result most of the
3675  * time. But probably not always!
3676  *
3677  * This does not address tzname aspects of NETaa14816.
3678  *
3679  */
3680
3681 #ifdef __GLIBC__
3682 # ifndef STRUCT_TM_HASZONE
3683 #    define STRUCT_TM_HASZONE
3684 # endif
3685 #endif
3686
3687 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3688 # ifndef HAS_TM_TM_ZONE
3689 #    define HAS_TM_TM_ZONE
3690 # endif
3691 #endif
3692
3693 void
3694 Perl_init_tm(pTHX_ struct tm *ptm)      /* see mktime, strftime and asctime */
3695 {
3696 #ifdef HAS_TM_TM_ZONE
3697     Time_t now;
3698     const struct tm* my_tm;
3699     PERL_UNUSED_CONTEXT;
3700     PERL_ARGS_ASSERT_INIT_TM;
3701     (void)time(&now);
3702     my_tm = localtime(&now);
3703     if (my_tm)
3704         Copy(my_tm, ptm, 1, struct tm);
3705 #else
3706     PERL_UNUSED_CONTEXT;
3707     PERL_ARGS_ASSERT_INIT_TM;
3708     PERL_UNUSED_ARG(ptm);
3709 #endif
3710 }
3711
3712 /*
3713  * mini_mktime - normalise struct tm values without the localtime()
3714  * semantics (and overhead) of mktime().
3715  */
3716 void
3717 Perl_mini_mktime(struct tm *ptm)
3718 {
3719     int yearday;
3720     int secs;
3721     int month, mday, year, jday;
3722     int odd_cent, odd_year;
3723
3724     PERL_ARGS_ASSERT_MINI_MKTIME;
3725
3726 #define DAYS_PER_YEAR   365
3727 #define DAYS_PER_QYEAR  (4*DAYS_PER_YEAR+1)
3728 #define DAYS_PER_CENT   (25*DAYS_PER_QYEAR-1)
3729 #define DAYS_PER_QCENT  (4*DAYS_PER_CENT+1)
3730 #define SECS_PER_HOUR   (60*60)
3731 #define SECS_PER_DAY    (24*SECS_PER_HOUR)
3732 /* parentheses deliberately absent on these two, otherwise they don't work */
3733 #define MONTH_TO_DAYS   153/5
3734 #define DAYS_TO_MONTH   5/153
3735 /* offset to bias by March (month 4) 1st between month/mday & year finding */
3736 #define YEAR_ADJUST     (4*MONTH_TO_DAYS+1)
3737 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
3738 #define WEEKDAY_BIAS    6       /* (1+6)%7 makes Sunday 0 again */
3739
3740 /*
3741  * Year/day algorithm notes:
3742  *
3743  * With a suitable offset for numeric value of the month, one can find
3744  * an offset into the year by considering months to have 30.6 (153/5) days,
3745  * using integer arithmetic (i.e., with truncation).  To avoid too much
3746  * messing about with leap days, we consider January and February to be
3747  * the 13th and 14th month of the previous year.  After that transformation,
3748  * we need the month index we use to be high by 1 from 'normal human' usage,
3749  * so the month index values we use run from 4 through 15.
3750  *
3751  * Given that, and the rules for the Gregorian calendar (leap years are those
3752  * divisible by 4 unless also divisible by 100, when they must be divisible
3753  * by 400 instead), we can simply calculate the number of days since some
3754  * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
3755  * the days we derive from our month index, and adding in the day of the
3756  * month.  The value used here is not adjusted for the actual origin which
3757  * it normally would use (1 January A.D. 1), since we're not exposing it.
3758  * We're only building the value so we can turn around and get the
3759  * normalised values for the year, month, day-of-month, and day-of-year.
3760  *
3761  * For going backward, we need to bias the value we're using so that we find
3762  * the right year value.  (Basically, we don't want the contribution of
3763  * March 1st to the number to apply while deriving the year).  Having done
3764  * that, we 'count up' the contribution to the year number by accounting for
3765  * full quadracenturies (400-year periods) with their extra leap days, plus
3766  * the contribution from full centuries (to avoid counting in the lost leap
3767  * days), plus the contribution from full quad-years (to count in the normal
3768  * leap days), plus the leftover contribution from any non-leap years.
3769  * At this point, if we were working with an actual leap day, we'll have 0
3770  * days left over.  This is also true for March 1st, however.  So, we have
3771  * to special-case that result, and (earlier) keep track of the 'odd'
3772  * century and year contributions.  If we got 4 extra centuries in a qcent,
3773  * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
3774  * Otherwise, we add back in the earlier bias we removed (the 123 from
3775  * figuring in March 1st), find the month index (integer division by 30.6),
3776  * and the remainder is the day-of-month.  We then have to convert back to
3777  * 'real' months (including fixing January and February from being 14/15 in
3778  * the previous year to being in the proper year).  After that, to get
3779  * tm_yday, we work with the normalised year and get a new yearday value for
3780  * January 1st, which we subtract from the yearday value we had earlier,
3781  * representing the date we've re-built.  This is done from January 1
3782  * because tm_yday is 0-origin.
3783  *
3784  * Since POSIX time routines are only guaranteed to work for times since the
3785  * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
3786  * applies Gregorian calendar rules even to dates before the 16th century
3787  * doesn't bother me.  Besides, you'd need cultural context for a given
3788  * date to know whether it was Julian or Gregorian calendar, and that's
3789  * outside the scope for this routine.  Since we convert back based on the
3790  * same rules we used to build the yearday, you'll only get strange results
3791  * for input which needed normalising, or for the 'odd' century years which
3792  * were leap years in the Julian calendar but not in the Gregorian one.
3793  * I can live with that.
3794  *
3795  * This algorithm also fails to handle years before A.D. 1 gracefully, but
3796  * that's still outside the scope for POSIX time manipulation, so I don't
3797  * care.
3798  */
3799
3800     year = 1900 + ptm->tm_year;
3801     month = ptm->tm_mon;
3802     mday = ptm->tm_mday;
3803     jday = 0;
3804     if (month >= 2)
3805         month+=2;
3806     else
3807         month+=14, year--;
3808     yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
3809     yearday += month*MONTH_TO_DAYS + mday + jday;
3810     /*
3811      * Note that we don't know when leap-seconds were or will be,
3812      * so we have to trust the user if we get something which looks
3813      * like a sensible leap-second.  Wild values for seconds will
3814      * be rationalised, however.
3815      */
3816     if ((unsigned) ptm->tm_sec <= 60) {
3817         secs = 0;
3818     }
3819     else {
3820         secs = ptm->tm_sec;
3821         ptm->tm_sec = 0;
3822     }
3823     secs += 60 * ptm->tm_min;
3824     secs += SECS_PER_HOUR * ptm->tm_hour;
3825     if (secs < 0) {
3826         if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
3827             /* got negative remainder, but need positive time */
3828             /* back off an extra day to compensate */
3829             yearday += (secs/SECS_PER_DAY)-1;
3830             secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
3831         }
3832         else {
3833             yearday += (secs/SECS_PER_DAY);
3834             secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
3835         }
3836     }
3837     else if (secs >= SECS_PER_DAY) {
3838         yearday += (secs/SECS_PER_DAY);
3839         secs %= SECS_PER_DAY;
3840     }
3841     ptm->tm_hour = secs/SECS_PER_HOUR;
3842     secs %= SECS_PER_HOUR;
3843     ptm->tm_min = secs/60;
3844     secs %= 60;
3845     ptm->tm_sec += secs;
3846     /* done with time of day effects */
3847     /*
3848      * The algorithm for yearday has (so far) left it high by 428.
3849      * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
3850      * bias it by 123 while trying to figure out what year it
3851      * really represents.  Even with this tweak, the reverse
3852      * translation fails for years before A.D. 0001.
3853      * It would still fail for Feb 29, but we catch that one below.
3854      */
3855     jday = yearday;     /* save for later fixup vis-a-vis Jan 1 */
3856     yearday -= YEAR_ADJUST;
3857     year = (yearday / DAYS_PER_QCENT) * 400;
3858     yearday %= DAYS_PER_QCENT;
3859     odd_cent = yearday / DAYS_PER_CENT;
3860     year += odd_cent * 100;
3861     yearday %= DAYS_PER_CENT;
3862     year += (yearday / DAYS_PER_QYEAR) * 4;
3863     yearday %= DAYS_PER_QYEAR;
3864     odd_year = yearday / DAYS_PER_YEAR;
3865     year += odd_year;
3866     yearday %= DAYS_PER_YEAR;
3867     if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
3868         month = 1;
3869         yearday = 29;
3870     }
3871     else {
3872         yearday += YEAR_ADJUST; /* recover March 1st crock */
3873         month = yearday*DAYS_TO_MONTH;
3874         yearday -= month*MONTH_TO_DAYS;
3875         /* recover other leap-year adjustment */
3876         if (month > 13) {
3877             month-=14;
3878             year++;
3879         }
3880         else {
3881             month-=2;
3882         }
3883     }
3884     ptm->tm_year = year - 1900;
3885     if (yearday) {
3886       ptm->tm_mday = yearday;
3887       ptm->tm_mon = month;
3888     }
3889     else {
3890       ptm->tm_mday = 31;
3891       ptm->tm_mon = month - 1;
3892     }
3893     /* re-build yearday based on Jan 1 to get tm_yday */
3894     year--;
3895     yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
3896     yearday += 14*MONTH_TO_DAYS + 1;
3897     ptm->tm_yday = jday - yearday;
3898     ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
3899 }
3900
3901 char *
3902 Perl_my_strftime(pTHX_ const char *fmt, int sec, int min, int hour, int mday, int mon, int year, int wday, int yday, int isdst)
3903 {
3904 #ifdef HAS_STRFTIME
3905
3906   /* Note that yday and wday effectively are ignored by this function, as mini_mktime() overwrites them */
3907
3908   char *buf;
3909   int buflen;
3910   struct tm mytm;
3911   int len;
3912
3913   PERL_ARGS_ASSERT_MY_STRFTIME;
3914
3915   init_tm(&mytm);       /* XXX workaround - see init_tm() above */
3916   mytm.tm_sec = sec;
3917   mytm.tm_min = min;
3918   mytm.tm_hour = hour;
3919   mytm.tm_mday = mday;
3920   mytm.tm_mon = mon;
3921   mytm.tm_year = year;
3922   mytm.tm_wday = wday;
3923   mytm.tm_yday = yday;
3924   mytm.tm_isdst = isdst;
3925   mini_mktime(&mytm);
3926   /* use libc to get the values for tm_gmtoff and tm_zone [perl #18238] */
3927 #if defined(HAS_MKTIME) && (defined(HAS_TM_TM_GMTOFF) || defined(HAS_TM_TM_ZONE))
3928   STMT_START {
3929     struct tm mytm2;
3930     mytm2 = mytm;
3931     mktime(&mytm2);
3932 #ifdef HAS_TM_TM_GMTOFF
3933     mytm.tm_gmtoff = mytm2.tm_gmtoff;
3934 #endif
3935 #ifdef HAS_TM_TM_ZONE
3936     mytm.tm_zone = mytm2.tm_zone;
3937 #endif
3938   } STMT_END;
3939 #endif
3940   buflen = 64;
3941   Newx(buf, buflen, char);
3942
3943   GCC_DIAG_IGNORE(-Wformat-nonliteral); /* fmt checked by caller */
3944   len = strftime(buf, buflen, fmt, &mytm);
3945   GCC_DIAG_RESTORE;
3946
3947   /*
3948   ** The following is needed to handle to the situation where
3949   ** tmpbuf overflows.  Basically we want to allocate a buffer
3950   ** and try repeatedly.  The reason why it is so complicated
3951   ** is that getting a return value of 0 from strftime can indicate
3952   ** one of the following:
3953   ** 1. buffer overflowed,
3954   ** 2. illegal conversion specifier, or
3955   ** 3. the format string specifies nothing to be returned(not
3956   **      an error).  This could be because format is an empty string
3957   **    or it specifies %p that yields an empty string in some locale.
3958   ** If there is a better way to make it portable, go ahead by
3959   ** all means.
3960   */
3961   if ((len > 0 && len < buflen) || (len == 0 && *fmt == '\0'))
3962     return buf;
3963   else {
3964     /* Possibly buf overflowed - try again with a bigger buf */
3965     const int fmtlen = strlen(fmt);
3966     int bufsize = fmtlen + buflen;
3967
3968     Renew(buf, bufsize, char);
3969     while (buf) {
3970
3971       GCC_DIAG_IGNORE(-Wformat-nonliteral); /* fmt checked by caller */
3972       buflen = strftime(buf, bufsize, fmt, &mytm);
3973       GCC_DIAG_RESTORE;
3974
3975       if (buflen > 0 && buflen < bufsize)
3976         break;
3977       /* heuristic to prevent out-of-memory errors */
3978       if (bufsize > 100*fmtlen) {
3979         Safefree(buf);
3980         buf = NULL;
3981         break;
3982       }
3983       bufsize *= 2;
3984       Renew(buf, bufsize, char);
3985     }
3986     return buf;
3987   }
3988 #else
3989   Perl_croak(aTHX_ "panic: no strftime");
3990   return NULL;
3991 #endif
3992 }
3993
3994
3995 #define SV_CWD_RETURN_UNDEF \
3996     sv_set_undef(sv); \
3997     return FALSE
3998
3999 #define SV_CWD_ISDOT(dp) \
4000     (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
4001         (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
4002
4003 /*
4004 =head1 Miscellaneous Functions
4005
4006 =for apidoc getcwd_sv
4007
4008 Fill C<sv> with current working directory
4009
4010 =cut
4011 */
4012
4013 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
4014  * rewritten again by dougm, optimized for use with xs TARG, and to prefer
4015  * getcwd(3) if available
4016  * Comments from the original:
4017  *     This is a faster version of getcwd.  It's also more dangerous
4018  *     because you might chdir out of a directory that you can't chdir
4019  *     back into. */
4020
4021 int
4022 Perl_getcwd_sv(pTHX_ SV *sv)
4023 {
4024 #ifndef PERL_MICRO
4025     SvTAINTED_on(sv);
4026
4027     PERL_ARGS_ASSERT_GETCWD_SV;
4028
4029 #ifdef HAS_GETCWD
4030     {
4031         char buf[MAXPATHLEN];
4032
4033         /* Some getcwd()s automatically allocate a buffer of the given
4034          * size from the heap if they are given a NULL buffer pointer.
4035          * The problem is that this behaviour is not portable. */
4036         if (getcwd(buf, sizeof(buf) - 1)) {
4037             sv_setpv(sv, buf);
4038             return TRUE;
4039         }
4040         else {
4041             SV_CWD_RETURN_UNDEF;
4042         }
4043     }
4044
4045 #else
4046
4047     Stat_t statbuf;
4048     int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
4049     int pathlen=0;
4050     Direntry_t *dp;
4051
4052     SvUPGRADE(sv, SVt_PV);
4053
4054     if (PerlLIO_lstat(".", &statbuf) < 0) {
4055         SV_CWD_RETURN_UNDEF;
4056     }
4057
4058     orig_cdev = statbuf.st_dev;
4059     orig_cino = statbuf.st_ino;
4060     cdev = orig_cdev;
4061     cino = orig_cino;
4062
4063     for (;;) {
4064         DIR *dir;
4065         int namelen;
4066         odev = cdev;
4067         oino = cino;
4068
4069         if (PerlDir_chdir("..") < 0) {
4070             SV_CWD_RETURN_UNDEF;
4071         }
4072         if (PerlLIO_stat(".", &statbuf) < 0) {
4073             SV_CWD_RETURN_UNDEF;
4074         }
4075
4076         cdev = statbuf.st_dev;
4077         cino = statbuf.st_ino;
4078
4079         if (odev == cdev && oino == cino) {
4080             break;
4081         }
4082         if (!(dir = PerlDir_open("."))) {
4083             SV_CWD_RETURN_UNDEF;
4084         }
4085
4086         while ((dp = PerlDir_read(dir)) != NULL) {
4087 #ifdef DIRNAMLEN
4088             namelen = dp->d_namlen;
4089 #else
4090             namelen = strlen(dp->d_name);
4091 #endif
4092             /* skip . and .. */
4093             if (SV_CWD_ISDOT(dp)) {
4094                 continue;
4095             }
4096
4097             if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
4098                 SV_CWD_RETURN_UNDEF;
4099             }
4100
4101             tdev = statbuf.st_dev;
4102             tino = statbuf.st_ino;
4103             if (tino == oino && tdev == odev) {
4104                 break;
4105             }
4106         }
4107
4108         if (!dp) {
4109             SV_CWD_RETURN_UNDEF;
4110         }
4111
4112         if (pathlen + namelen + 1 >= MAXPATHLEN) {
4113             SV_CWD_RETURN_UNDEF;
4114         }
4115
4116         SvGROW(sv, pathlen + namelen + 1);
4117
4118         if (pathlen) {
4119             /* shift down */
4120             Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
4121         }
4122
4123         /* prepend current directory to the front */
4124         *SvPVX(sv) = '/';
4125         Move(dp->d_name, SvPVX(sv)+1, namelen, char);
4126         pathlen += (namelen + 1);
4127
4128 #ifdef VOID_CLOSEDIR
4129         PerlDir_close(dir);
4130 #else
4131         if (PerlDir_close(dir) < 0) {
4132             SV_CWD_RETURN_UNDEF;
4133         }
4134 #endif
4135     }
4136
4137     if (pathlen) {
4138         SvCUR_set(sv, pathlen);
4139         *SvEND(sv) = '\0';
4140         SvPOK_only(sv);
4141
4142         if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
4143             SV_CWD_RETURN_UNDEF;
4144         }
4145     }
4146     if (PerlLIO_stat(".", &statbuf) < 0) {
4147         SV_CWD_RETURN_UNDEF;
4148     }
4149
4150     cdev = statbuf.st_dev;
4151     cino = statbuf.st_ino;
4152
4153     if (cdev != orig_cdev || cino != orig_cino) {
4154         Perl_croak(aTHX_ "Unstable directory path, "
4155                    "current directory changed unexpectedly");
4156     }
4157
4158     return TRUE;
4159 #endif
4160
4161 #else
4162     return FALSE;
4163 #endif
4164 }
4165
4166 #include "vutil.c"
4167
4168 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET) && defined(SOCK_DGRAM) && defined(HAS_SELECT)
4169 #   define EMULATE_SOCKETPAIR_UDP
4170 #endif
4171
4172 #ifdef EMULATE_SOCKETPAIR_UDP
4173 static int
4174 S_socketpair_udp (int fd[2]) {
4175     dTHX;
4176     /* Fake a datagram socketpair using UDP to localhost.  */
4177     int sockets[2] = {-1, -1};
4178     struct sockaddr_in addresses[2];
4179     int i;
4180     Sock_size_t size = sizeof(struct sockaddr_in);
4181     unsigned short port;
4182     int got;
4183
4184     memset(&addresses, 0, sizeof(addresses));
4185     i = 1;
4186     do {
4187         sockets[i] = PerlSock_socket(AF_INET, SOCK_DGRAM, PF_INET);
4188         if (sockets[i] == -1)
4189             goto tidy_up_and_fail;
4190
4191         addresses[i].sin_family = AF_INET;
4192         addresses[i].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4193         addresses[i].sin_port = 0;      /* kernel choses port.  */
4194         if (PerlSock_bind(sockets[i], (struct sockaddr *) &addresses[i],
4195                 sizeof(struct sockaddr_in)) == -1)
4196             goto tidy_up_and_fail;
4197     } while (i--);
4198
4199     /* Now have 2 UDP sockets. Find out which port each is connected to, and
4200        for each connect the other socket to it.  */
4201     i = 1;
4202     do {
4203         if (PerlSock_getsockname(sockets[i], (struct sockaddr *) &addresses[i],
4204                 &size) == -1)
4205             goto tidy_up_and_fail;
4206         if (size != sizeof(struct sockaddr_in))
4207             goto abort_tidy_up_and_fail;
4208         /* !1 is 0, !0 is 1 */
4209         if (PerlSock_connect(sockets[!i], (struct sockaddr *) &addresses[i],
4210                 sizeof(struct sockaddr_in)) == -1)
4211             goto tidy_up_and_fail;
4212     } while (i--);
4213
4214     /* Now we have 2 sockets connected to each other. I don't trust some other
4215        process not to have already sent a packet to us (by random) so send
4216        a packet from each to the other.  */
4217     i = 1;
4218     do {
4219         /* I'm going to send my own port number.  As a short.
4220            (Who knows if someone somewhere has sin_port as a bitfield and needs
4221            this routine. (I'm assuming crays have socketpair)) */
4222         port = addresses[i].sin_port;
4223         got = PerlLIO_write(sockets[i], &port, sizeof(port));
4224         if (got != sizeof(port)) {
4225             if (got == -1)
4226                 goto tidy_up_and_fail;
4227             goto abort_tidy_up_and_fail;
4228         }
4229     } while (i--);
4230
4231     /* Packets sent. I don't trust them to have arrived though.
4232        (As I understand it Solaris TCP stack is multithreaded. Non-blocking
4233        connect to localhost will use a second kernel thread. In 2.6 the
4234        first thread running the connect() returns before the second completes,
4235        so EINPROGRESS> In 2.7 the improved stack is faster and connect()
4236        returns 0. Poor programs have tripped up. One poor program's authors'
4237        had a 50-1 reverse stock split. Not sure how connected these were.)
4238        So I don't trust someone not to have an unpredictable UDP stack.
4239     */
4240
4241     {
4242         struct timeval waitfor = {0, 100000}; /* You have 0.1 seconds */
4243         int max = sockets[1] > sockets[0] ? sockets[1] : sockets[0];
4244         fd_set rset;
4245
4246         FD_ZERO(&rset);
4247         FD_SET((unsigned int)sockets[0], &rset);
4248         FD_SET((unsigned int)sockets[1], &rset);
4249
4250         got = PerlSock_select(max + 1, &rset, NULL, NULL, &waitfor);
4251         if (got != 2 || !FD_ISSET(sockets[0], &rset)
4252                 || !FD_ISSET(sockets[1], &rset)) {
4253             /* I hope this is portable and appropriate.  */
4254             if (got == -1)
4255                 goto tidy_up_and_fail;
4256             goto abort_tidy_up_and_fail;
4257         }
4258     }
4259
4260     /* And the paranoia department even now doesn't trust it to have arrive
4261        (hence MSG_DONTWAIT). Or that what arrives was sent by us.  */
4262     {
4263         struct sockaddr_in readfrom;
4264         unsigned short buffer[2];
4265
4266         i = 1;
4267         do {
4268 #ifdef MSG_DONTWAIT
4269             got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4270                     sizeof(buffer), MSG_DONTWAIT,
4271                     (struct sockaddr *) &readfrom, &size);
4272 #else
4273             got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4274                     sizeof(buffer), 0,
4275                     (struct sockaddr *) &readfrom, &size);
4276 #endif
4277
4278             if (got == -1)
4279                 goto tidy_up_and_fail;
4280             if (got != sizeof(port)
4281                     || size != sizeof(struct sockaddr_in)
4282                     /* Check other socket sent us its port.  */
4283                     || buffer[0] != (unsigned short) addresses[!i].sin_port
4284                     /* Check kernel says we got the datagram from that socket */
4285                     || readfrom.sin_family != addresses[!i].sin_family
4286                     || readfrom.sin_addr.s_addr != addresses[!i].sin_addr.s_addr
4287                     || readfrom.sin_port != addresses[!i].sin_port)
4288                 goto abort_tidy_up_and_fail;
4289         } while (i--);
4290     }
4291     /* My caller (my_socketpair) has validated that this is non-NULL  */
4292     fd[0] = sockets[0];
4293     fd[1] = sockets[1];
4294     /* I hereby declare this connection open.  May God bless all who cross
4295        her.  */
4296     return 0;
4297
4298   abort_tidy_up_and_fail:
4299     errno = ECONNABORTED;
4300   tidy_up_and_fail:
4301     {
4302         dSAVE_ERRNO;
4303         if (sockets[0] != -1)
4304             PerlLIO_close(sockets[0]);
4305         if (sockets[1] != -1)
4306             PerlLIO_close(sockets[1]);
4307         RESTORE_ERRNO;
4308         return -1;
4309     }
4310 }
4311 #endif /*  EMULATE_SOCKETPAIR_UDP */
4312
4313 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET)
4314 int
4315 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4316     /* Stevens says that family must be AF_LOCAL, protocol 0.
4317        I'm going to enforce that, then ignore it, and use TCP (or UDP).  */
4318     dTHXa(NULL);
4319     int listener = -1;
4320     int connector = -1;
4321     int acceptor = -1;
4322     struct sockaddr_in listen_addr;
4323     struct sockaddr_in connect_addr;
4324     Sock_size_t size;
4325
4326     if (protocol
4327 #ifdef AF_UNIX
4328         || family != AF_UNIX
4329 #endif
4330     ) {
4331         errno = EAFNOSUPPORT;
4332         return -1;
4333     }
4334     if (!fd) {
4335         errno = EINVAL;
4336         return -1;
4337     }
4338
4339 #ifdef EMULATE_SOCKETPAIR_UDP
4340     if (type == SOCK_DGRAM)
4341         return S_socketpair_udp(fd);
4342 #endif
4343
4344     aTHXa(PERL_GET_THX);
4345     listener = PerlSock_socket(AF_INET, type, 0);
4346     if (listener == -1)
4347         return -1;
4348     memset(&listen_addr, 0, sizeof(listen_addr));
4349     listen_addr.sin_family = AF_INET;
4350     listen_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4351     listen_addr.sin_port = 0;   /* kernel choses port.  */
4352     if (PerlSock_bind(listener, (struct sockaddr *) &listen_addr,
4353             sizeof(listen_addr)) == -1)
4354         goto tidy_up_and_fail;
4355     if (PerlSock_listen(listener, 1) == -1)
4356         goto tidy_up_and_fail;
4357
4358     connector = PerlSock_socket(AF_INET, type, 0);
4359     if (connector == -1)
4360         goto tidy_up_and_fail;
4361     /* We want to find out the port number to connect to.  */
4362     size = sizeof(connect_addr);
4363     if (PerlSock_getsockname(listener, (struct sockaddr *) &connect_addr,
4364             &size) == -1)
4365         goto tidy_up_and_fail;
4366     if (size != sizeof(connect_addr))
4367         goto abort_tidy_up_and_fail;
4368     if (PerlSock_connect(connector, (struct sockaddr *) &connect_addr,
4369             sizeof(connect_addr)) == -1)
4370         goto tidy_up_and_fail;
4371
4372     size = sizeof(listen_addr);
4373     acceptor = PerlSock_accept(listener, (struct sockaddr *) &listen_addr,
4374             &size);
4375     if (acceptor == -1)
4376         goto tidy_up_and_fail;
4377     if (size != sizeof(listen_addr))
4378         goto abort_tidy_up_and_fail;
4379     PerlLIO_close(listener);
4380     /* Now check we are talking to ourself by matching port and host on the
4381        two sockets.  */
4382     if (PerlSock_getsockname(connector, (struct sockaddr *) &connect_addr,
4383             &size) == -1)
4384         goto tidy_up_and_fail;
4385     if (size != sizeof(connect_addr)
4386             || listen_addr.sin_family != connect_addr.sin_family
4387             || listen_addr.sin_addr.s_addr != connect_addr.sin_addr.s_addr
4388             || listen_addr.sin_port != connect_addr.sin_port) {
4389         goto abort_tidy_up_and_fail;
4390     }
4391     fd[0] = connector;
4392     fd[1] = acceptor;
4393     return 0;
4394
4395   abort_tidy_up_and_fail:
4396 #ifdef ECONNABORTED
4397   errno = ECONNABORTED; /* This would be the standard thing to do. */
4398 #else
4399 #  ifdef ECONNREFUSED
4400   errno = ECONNREFUSED; /* E.g. Symbian does not have ECONNABORTED. */
4401 #  else
4402   errno = ETIMEDOUT;    /* Desperation time. */
4403 #  endif
4404 #endif
4405   tidy_up_and_fail:
4406     {
4407         dSAVE_ERRNO;
4408         if (listener != -1)
4409             PerlLIO_close(listener);
4410         if (connector != -1)
4411             PerlLIO_close(connector);
4412         if (acceptor != -1)
4413             PerlLIO_close(acceptor);
4414         RESTORE_ERRNO;
4415         return -1;
4416     }
4417 }
4418 #else
4419 /* In any case have a stub so that there's code corresponding
4420  * to the my_socketpair in embed.fnc. */
4421 int
4422 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4423 #ifdef HAS_SOCKETPAIR
4424     return socketpair(family, type, protocol, fd);
4425 #else
4426     return -1;
4427 #endif
4428 }
4429 #endif
4430
4431 /*
4432
4433 =for apidoc sv_nosharing
4434
4435 Dummy routine which "shares" an SV when there is no sharing module present.
4436 Or "locks" it.  Or "unlocks" it.  In other
4437 words, ignores its single SV argument.
4438 Exists to avoid test for a C<NULL> function pointer and because it could
4439 potentially warn under some level of strict-ness.
4440
4441 =cut
4442 */
4443
4444 void
4445 Perl_sv_nosharing(pTHX_ SV *sv)
4446 {
4447     PERL_UNUSED_CONTEXT;
4448     PERL_UNUSED_ARG(sv);
4449 }
4450
4451 /*
4452
4453 =for apidoc sv_destroyable
4454
4455 Dummy routine which reports that object can be destroyed when there is no
4456 sharing module present.  It ignores its single SV argument, and returns
4457 'true'.  Exists to avoid test for a C<NULL> function pointer and because it
4458 could potentially warn under some level of strict-ness.
4459
4460 =cut
4461 */
4462
4463 bool
4464 Perl_sv_destroyable(pTHX_ SV *sv)
4465 {
4466     PERL_UNUSED_CONTEXT;
4467     PERL_UNUSED_ARG(sv);
4468     return TRUE;
4469 }
4470
4471 U32
4472 Perl_parse_unicode_opts(pTHX_ const char **popt)
4473 {
4474   const char *p = *popt;
4475   U32 opt = 0;
4476
4477   PERL_ARGS_ASSERT_PARSE_UNICODE_OPTS;
4478
4479   if (*p) {
4480        if (isDIGIT(*p)) {
4481             const char* endptr;
4482             UV uv;
4483             if (grok_atoUV(p, &uv, &endptr) && uv <= U32_MAX) {
4484                 opt = (U32)uv;
4485                 p = endptr;
4486                 if (p && *p && *p != '\n' && *p != '\r') {
4487                     if (isSPACE(*p))
4488                         goto the_end_of_the_opts_parser;
4489                     else
4490                         Perl_croak(aTHX_ "Unknown Unicode option letter '%c'", *p);
4491                 }
4492             }
4493             else {
4494                 Perl_croak(aTHX_ "Invalid number '%s' for -C option.\n", p);
4495             }
4496         }
4497         else {
4498             for (; *p; p++) {
4499                  switch (*p) {
4500                  case PERL_UNICODE_STDIN:
4501                       opt |= PERL_UNICODE_STDIN_FLAG;   break;
4502                  case PERL_UNICODE_STDOUT:
4503                       opt |= PERL_UNICODE_STDOUT_FLAG;  break;
4504                  case PERL_UNICODE_STDERR:
4505                       opt |= PERL_UNICODE_STDERR_FLAG;  break;
4506                  case PERL_UNICODE_STD:
4507                       opt |= PERL_UNICODE_STD_FLAG;     break;
4508                  case PERL_UNICODE_IN:
4509                       opt |= PERL_UNICODE_IN_FLAG;      break;
4510                  case PERL_UNICODE_OUT:
4511                       opt |= PERL_UNICODE_OUT_FLAG;     break;
4512                  case PERL_UNICODE_INOUT:
4513                       opt |= PERL_UNICODE_INOUT_FLAG;   break;
4514                  case PERL_UNICODE_LOCALE:
4515                       opt |= PERL_UNICODE_LOCALE_FLAG;  break;
4516                  case PERL_UNICODE_ARGV:
4517                       opt |= PERL_UNICODE_ARGV_FLAG;    break;
4518                  case PERL_UNICODE_UTF8CACHEASSERT:
4519                       opt |= PERL_UNICODE_UTF8CACHEASSERT_FLAG; break;
4520                  default:
4521                       if (*p != '\n' && *p != '\r') {
4522                         if(isSPACE(*p)) goto the_end_of_the_opts_parser;
4523                         else
4524                           Perl_croak(aTHX_
4525                                      "Unknown Unicode option letter '%c'", *p);
4526                       }
4527                  }
4528             }
4529        }
4530   }
4531   else
4532        opt = PERL_UNICODE_DEFAULT_FLAGS;
4533
4534   the_end_of_the_opts_parser:
4535
4536   if (opt & ~PERL_UNICODE_ALL_FLAGS)
4537        Perl_croak(aTHX_ "Unknown Unicode option value %" UVuf,
4538                   (UV) (opt & ~PERL_UNICODE_ALL_FLAGS));
4539
4540   *popt = p;
4541
4542   return opt;
4543 }
4544
4545 #ifdef VMS
4546 #  include <starlet.h>
4547 #endif
4548
4549 U32
4550 Perl_seed(pTHX)
4551 {
4552     /*
4553      * This is really just a quick hack which grabs various garbage
4554      * values.  It really should be a real hash algorithm which
4555      * spreads the effect of every input bit onto every output bit,
4556      * if someone who knows about such things would bother to write it.
4557      * Might be a good idea to add that function to CORE as well.
4558      * No numbers below come from careful analysis or anything here,
4559      * except they are primes and SEED_C1 > 1E6 to get a full-width
4560      * value from (tv_sec * SEED_C1 + tv_usec).  The multipliers should
4561      * probably be bigger too.
4562      */
4563 #if RANDBITS > 16
4564 #  define SEED_C1       1000003
4565 #define   SEED_C4       73819
4566 #else
4567 #  define SEED_C1       25747
4568 #define   SEED_C4       20639
4569 #endif
4570 #define   SEED_C2       3
4571 #define   SEED_C3       269
4572 #define   SEED_C5       26107
4573
4574 #ifndef PERL_NO_DEV_RANDOM
4575     int fd;
4576 #endif
4577     U32 u;
4578 #ifdef HAS_GETTIMEOFDAY
4579     struct timeval when;
4580 #else
4581     Time_t when;
4582 #endif
4583
4584 /* This test is an escape hatch, this symbol isn't set by Configure. */
4585 #ifndef PERL_NO_DEV_RANDOM
4586 #ifndef PERL_RANDOM_DEVICE
4587    /* /dev/random isn't used by default because reads from it will block
4588     * if there isn't enough entropy available.  You can compile with
4589     * PERL_RANDOM_DEVICE to it if you'd prefer Perl to block until there
4590     * is enough real entropy to fill the seed. */
4591 #  ifdef __amigaos4__
4592 #    define PERL_RANDOM_DEVICE "RANDOM:SIZE=4"
4593 #  else
4594 #    define PERL_RANDOM_DEVICE "/dev/urandom"
4595 #  endif
4596 #endif
4597     fd = PerlLIO_open(PERL_RANDOM_DEVICE, 0);
4598     if (fd != -1) {
4599         if (PerlLIO_read(fd, (void*)&u, sizeof u) != sizeof u)
4600             u = 0;
4601         PerlLIO_close(fd);
4602         if (u)
4603             return u;
4604     }
4605 #endif
4606
4607 #ifdef HAS_GETTIMEOFDAY
4608     PerlProc_gettimeofday(&when,NULL);
4609     u = (U32)SEED_C1 * when.tv_sec + (U32)SEED_C2 * when.tv_usec;
4610 #else
4611     (void)time(&when);
4612     u = (U32)SEED_C1 * when;
4613 #endif
4614     u += SEED_C3 * (U32)PerlProc_getpid();
4615     u += SEED_C4 * (U32)PTR2UV(PL_stack_sp);
4616 #ifndef PLAN9           /* XXX Plan9 assembler chokes on this; fix needed  */
4617     u += SEED_C5 * (U32)PTR2UV(&when);
4618 #endif
4619     return u;
4620 }
4621
4622 void
4623 Perl_get_hash_seed(pTHX_ unsigned char * const seed_buffer)
4624 {
4625 #ifndef NO_PERL_HASH_ENV
4626     const char *env_pv;
4627 #endif
4628     unsigned long i;
4629
4630     PERL_ARGS_ASSERT_GET_HASH_SEED;
4631
4632 #ifndef NO_PERL_HASH_ENV
4633     env_pv= PerlEnv_getenv("PERL_HASH_SEED");
4634
4635     if ( env_pv )
4636     {
4637         /* ignore leading spaces */
4638         while (isSPACE(*env_pv))
4639             env_pv++;
4640 #    ifdef USE_PERL_PERTURB_KEYS
4641         /* if they set it to "0" we disable key traversal randomization completely */
4642         if (strEQ(env_pv,"0")) {
4643             PL_hash_rand_bits_enabled= 0;
4644         } else {
4645             /* otherwise switch to deterministic mode */
4646             PL_hash_rand_bits_enabled= 2;
4647         }
4648 #    endif
4649         /* ignore a leading 0x... if it is there */
4650         if (env_pv[0] == '0' && env_pv[1] == 'x')
4651             env_pv += 2;
4652
4653         for( i = 0; isXDIGIT(*env_pv) && i < PERL_HASH_SEED_BYTES; i++ ) {
4654             seed_buffer[i] = READ_XDIGIT(env_pv) << 4;
4655             if ( isXDIGIT(*env_pv)) {
4656                 seed_buffer[i] |= READ_XDIGIT(env_pv);
4657             }
4658         }
4659         while (isSPACE(*env_pv))
4660             env_pv++;
4661
4662         if (*env_pv && !isXDIGIT(*env_pv)) {
4663             Perl_warn(aTHX_ "perl: warning: Non hex character in '$ENV{PERL_HASH_SEED}', seed only partially set\n");
4664         }
4665         /* should we check for unparsed crap? */
4666         /* should we warn about unused hex? */
4667         /* should we warn about insufficient hex? */
4668     }
4669     else
4670 #endif /* NO_PERL_HASH_ENV */
4671     {
4672         (void)seedDrand01((Rand_seed_t)seed());
4673
4674         for( i = 0; i < PERL_HASH_SEED_BYTES; i++ ) {
4675             seed_buffer[i] = (unsigned char)(Drand01() * (U8_MAX+1));
4676         }
4677     }
4678 #ifdef USE_PERL_PERTURB_KEYS
4679     {   /* initialize PL_hash_rand_bits from the hash seed.
4680          * This value is highly volatile, it is updated every
4681          * hash insert, and is used as part of hash bucket chain
4682          * randomization and hash iterator randomization. */
4683         PL_hash_rand_bits= 0xbe49d17f; /* I just picked a number */
4684         for( i = 0; i < sizeof(UV) ; i++ ) {
4685             PL_hash_rand_bits += seed_buffer[i % PERL_HASH_SEED_BYTES];
4686             PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,8);
4687         }
4688     }
4689 #  ifndef NO_PERL_HASH_ENV
4690     env_pv= PerlEnv_getenv("PERL_PERTURB_KEYS");
4691     if (env_pv) {
4692         if (strEQ(env_pv,"0") || strEQ(env_pv,"NO")) {
4693             PL_hash_rand_bits_enabled= 0;
4694         } else if (strEQ(env_pv,"1") || strEQ(env_pv,"RANDOM")) {
4695             PL_hash_rand_bits_enabled= 1;
4696         } else if (strEQ(env_pv,"2") || strEQ(env_pv,"DETERMINISTIC")) {
4697             PL_hash_rand_bits_enabled= 2;
4698         } else {
4699             Perl_warn(aTHX_ "perl: warning: strange setting in '$ENV{PERL_PERTURB_KEYS}': '%s'\n", env_pv);
4700         }
4701     }
4702 #  endif
4703 #endif
4704 }
4705
4706 #ifdef PERL_GLOBAL_STRUCT
4707
4708 #define PERL_GLOBAL_STRUCT_INIT
4709 #include "opcode.h" /* the ppaddr and check */
4710
4711 struct perl_vars *
4712 Perl_init_global_struct(pTHX)
4713 {
4714     struct perl_vars *plvarsp = NULL;
4715 # ifdef PERL_GLOBAL_STRUCT
4716     const IV nppaddr = C_ARRAY_LENGTH(Gppaddr);
4717     const IV ncheck  = C_ARRAY_LENGTH(Gcheck);
4718     PERL_UNUSED_CONTEXT;
4719 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
4720     /* PerlMem_malloc() because can't use even safesysmalloc() this early. */
4721     plvarsp = (struct perl_vars*)PerlMem_malloc(sizeof(struct perl_vars));
4722     if (!plvarsp)
4723         exit(1);
4724 #  else
4725     plvarsp = PL_VarsPtr;
4726 #  endif /* PERL_GLOBAL_STRUCT_PRIVATE */
4727 #  undef PERLVAR
4728 #  undef PERLVARA
4729 #  undef PERLVARI
4730 #  undef PERLVARIC
4731 #  define PERLVAR(prefix,var,type) /**/
4732 #  define PERLVARA(prefix,var,n,type) /**/
4733 #  define PERLVARI(prefix,var,type,init) plvarsp->prefix##var = init;
4734 #  define PERLVARIC(prefix,var,type,init) plvarsp->prefix##var = init;
4735 #  include "perlvars.h"
4736 #  undef PERLVAR
4737 #  undef PERLVARA
4738 #  undef PERLVARI
4739 #  undef PERLVARIC
4740 #  ifdef PERL_GLOBAL_STRUCT
4741     plvarsp->Gppaddr =
4742         (Perl_ppaddr_t*)
4743         PerlMem_malloc(nppaddr * sizeof(Perl_ppaddr_t));
4744     if (!plvarsp->Gppaddr)
4745         exit(1);
4746     plvarsp->Gcheck  =
4747         (Perl_check_t*)
4748         PerlMem_malloc(ncheck  * sizeof(Perl_check_t));
4749     if (!plvarsp->Gcheck)
4750         exit(1);
4751     Copy(Gppaddr, plvarsp->Gppaddr, nppaddr, Perl_ppaddr_t);
4752     Copy(Gcheck,  plvarsp->Gcheck,  ncheck,  Perl_check_t);
4753 #  endif
4754 #  ifdef PERL_SET_VARS
4755     PERL_SET_VARS(plvarsp);
4756 #  endif
4757 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
4758     plvarsp->Gsv_placeholder.sv_flags = 0;
4759     memset(plvarsp->Ghash_seed, 0, sizeof(plvarsp->Ghash_seed));
4760 #  endif
4761 # undef PERL_GLOBAL_STRUCT_INIT
4762 # endif
4763     return plvarsp;
4764 }
4765
4766 #endif /* PERL_GLOBAL_STRUCT */
4767
4768 #ifdef PERL_GLOBAL_STRUCT
4769
4770 void
4771 Perl_free_global_struct(pTHX_ struct perl_vars *plvarsp)
4772 {
4773     int veto = plvarsp->Gveto_cleanup;
4774
4775     PERL_ARGS_ASSERT_FREE_GLOBAL_STRUCT;
4776     PERL_UNUSED_CONTEXT;
4777 # ifdef PERL_GLOBAL_STRUCT
4778 #  ifdef PERL_UNSET_VARS
4779     PERL_UNSET_VARS(plvarsp);
4780 #  endif
4781     if (veto)
4782         return;
4783     free(plvarsp->Gppaddr);
4784     free(plvarsp->Gcheck);
4785 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
4786     free(plvarsp);
4787 #  endif
4788 # endif
4789 }
4790
4791 #endif /* PERL_GLOBAL_STRUCT */
4792
4793 #ifdef PERL_MEM_LOG
4794
4795 /* -DPERL_MEM_LOG: the Perl_mem_log_..() is compiled, including
4796  * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
4797  * given, and you supply your own implementation.
4798  *
4799  * The default implementation reads a single env var, PERL_MEM_LOG,
4800  * expecting one or more of the following:
4801  *
4802  *    \d+ - fd          fd to write to          : must be 1st (grok_atoUV)
4803  *    'm' - memlog      was PERL_MEM_LOG=1
4804  *    's' - svlog       was PERL_SV_LOG=1
4805  *    't' - timestamp   was PERL_MEM_LOG_TIMESTAMP=1
4806  *
4807  * This makes the logger controllable enough that it can reasonably be
4808  * added to the system perl.
4809  */
4810
4811 /* -DPERL_MEM_LOG_SPRINTF_BUF_SIZE=X: size of a (stack-allocated) buffer
4812  * the Perl_mem_log_...() will use (either via sprintf or snprintf).
4813  */
4814 #define PERL_MEM_LOG_SPRINTF_BUF_SIZE 128
4815
4816 /* -DPERL_MEM_LOG_FD=N: the file descriptor the Perl_mem_log_...()
4817  * writes to.  In the default logger, this is settable at runtime.
4818  */
4819 #ifndef PERL_MEM_LOG_FD
4820 #  define PERL_MEM_LOG_FD 2 /* If STDERR is too boring for you. */
4821 #endif
4822
4823 #ifndef PERL_MEM_LOG_NOIMPL
4824
4825 # ifdef DEBUG_LEAKING_SCALARS
4826 #   define SV_LOG_SERIAL_FMT        " [%lu]"
4827 #   define _SV_LOG_SERIAL_ARG(sv)   , (unsigned long) (sv)->sv_debug_serial
4828 # else
4829 #   define SV_LOG_SERIAL_FMT
4830 #   define _SV_LOG_SERIAL_ARG(sv)
4831 # endif
4832
4833 static void
4834 S_mem_log_common(enum mem_log_type mlt, const UV n,
4835                  const UV typesize, const char *type_name, const SV *sv,
4836                  Malloc_t oldalloc, Malloc_t newalloc,
4837                  const char *filename, const int linenumber,
4838                  const char *funcname)
4839 {
4840     const char *pmlenv;
4841
4842     PERL_ARGS_ASSERT_MEM_LOG_COMMON;
4843
4844     pmlenv = PerlEnv_getenv("PERL_MEM_LOG");
4845     if (!pmlenv)
4846         return;
4847     if (mlt < MLT_NEW_SV ? strchr(pmlenv,'m') : strchr(pmlenv,'s'))
4848     {
4849         /* We can't use SVs or PerlIO for obvious reasons,
4850          * so we'll use stdio and low-level IO instead. */
4851         char buf[PERL_MEM_LOG_SPRINTF_BUF_SIZE];
4852
4853 #   ifdef HAS_GETTIMEOFDAY
4854 #     define MEM_LOG_TIME_FMT   "%10d.%06d: "
4855 #     define MEM_LOG_TIME_ARG   (int)tv.tv_sec, (int)tv.tv_usec
4856         struct timeval tv;
4857         gettimeofday(&tv, 0);
4858 #   else
4859 #     define MEM_LOG_TIME_FMT   "%10d: "
4860 #     define MEM_LOG_TIME_ARG   (int)when
4861         Time_t when;
4862         (void)time(&when);
4863 #   endif
4864         /* If there are other OS specific ways of hires time than
4865          * gettimeofday() (see dist/Time-HiRes), the easiest way is
4866          * probably that they would be used to fill in the struct
4867          * timeval. */
4868         {
4869             STRLEN len;
4870             const char* endptr;
4871             int fd;
4872             UV uv;
4873             if (grok_atoUV(pmlenv, &uv, &endptr) /* Ignore endptr. */
4874                 && uv && uv <= PERL_INT_MAX
4875             ) {
4876                 fd = (int)uv;
4877             } else {
4878                 fd = PERL_MEM_LOG_FD;
4879             }
4880
4881             if (strchr(pmlenv, 't')) {
4882                 len = my_snprintf(buf, sizeof(buf),
4883                                 MEM_LOG_TIME_FMT, MEM_LOG_TIME_ARG);
4884                 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4885             }
4886             switch (mlt) {
4887             case MLT_ALLOC:
4888                 len = my_snprintf(buf, sizeof(buf),
4889                         "alloc: %s:%d:%s: %" IVdf " %" UVuf
4890                         " %s = %" IVdf ": %" UVxf "\n",
4891                         filename, linenumber, funcname, n, typesize,
4892                         type_name, n * typesize, PTR2UV(newalloc));
4893                 break;
4894             case MLT_REALLOC:
4895                 len = my_snprintf(buf, sizeof(buf),
4896                         "realloc: %s:%d:%s: %" IVdf " %" UVuf
4897                         " %s = %" IVdf ": %" UVxf " -> %" UVxf "\n",
4898                         filename, linenumber, funcname, n, typesize,
4899                         type_name, n * typesize, PTR2UV(oldalloc),
4900                         PTR2UV(newalloc));
4901                 break;
4902             case MLT_FREE:
4903                 len = my_snprintf(buf, sizeof(buf),
4904                         "free: %s:%d:%s: %" UVxf "\n",
4905                         filename, linenumber, funcname,
4906                         PTR2UV(oldalloc));
4907                 break;
4908             case MLT_NEW_SV:
4909             case MLT_DEL_SV:
4910                 len = my_snprintf(buf, sizeof(buf),
4911                         "%s_SV: %s:%d:%s: %" UVxf SV_LOG_SERIAL_FMT "\n",
4912                         mlt == MLT_NEW_SV ? "new" : "del",
4913                         filename, linenumber, funcname,
4914                         PTR2UV(sv) _SV_LOG_SERIAL_ARG(sv));
4915                 break;
4916             default:
4917                 len = 0;
4918             }
4919             PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4920         }
4921     }
4922 }
4923 #endif /* !PERL_MEM_LOG_NOIMPL */
4924
4925 #ifndef PERL_MEM_LOG_NOIMPL
4926 # define \
4927     mem_log_common_if(alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm) \
4928     mem_log_common   (alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm)
4929 #else
4930 /* this is suboptimal, but bug compatible.  User is providing their
4931    own implementation, but is getting these functions anyway, and they
4932    do nothing. But _NOIMPL users should be able to cope or fix */
4933 # define \
4934     mem_log_common_if(alty, num, tysz, tynm, u, oal, nal, flnm, ln, fnnm) \
4935     /* mem_log_common_if_PERL_MEM_LOG_NOIMPL */
4936 #endif
4937
4938 Malloc_t
4939 Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name,
4940                    Malloc_t newalloc,
4941                    const char *filename, const int linenumber,
4942                    const char *funcname)
4943 {
4944     PERL_ARGS_ASSERT_MEM_LOG_ALLOC;
4945
4946     mem_log_common_if(MLT_ALLOC, n, typesize, type_name,
4947                       NULL, NULL, newalloc,
4948                       filename, linenumber, funcname);
4949     return newalloc;
4950 }
4951
4952 Malloc_t
4953 Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name,
4954                      Malloc_t oldalloc, Malloc_t newalloc,
4955                      const char *filename, const int linenumber,
4956                      const char *funcname)
4957 {
4958     PERL_ARGS_ASSERT_MEM_LOG_REALLOC;
4959
4960     mem_log_common_if(MLT_REALLOC, n, typesize, type_name,
4961                       NULL, oldalloc, newalloc,
4962                       filename, linenumber, funcname);
4963     return newalloc;
4964 }
4965
4966 Malloc_t
4967 Perl_mem_log_free(Malloc_t oldalloc,
4968                   const char *filename, const int linenumber,
4969                   const char *funcname)
4970 {
4971     PERL_ARGS_ASSERT_MEM_LOG_FREE;
4972
4973     mem_log_common_if(MLT_FREE, 0, 0, "", NULL, oldalloc, NULL,
4974                       filename, linenumber, funcname);
4975     return oldalloc;
4976 }
4977
4978 void
4979 Perl_mem_log_new_sv(const SV *sv,
4980                     const char *filename, const int linenumber,
4981                     const char *funcname)
4982 {
4983     mem_log_common_if(MLT_NEW_SV, 0, 0, "", sv, NULL, NULL,
4984                       filename, linenumber, funcname);
4985 }
4986
4987 void
4988 Perl_mem_log_del_sv(const SV *sv,
4989                     const char *filename, const int linenumber,
4990                     const char *funcname)
4991 {
4992     mem_log_common_if(MLT_DEL_SV, 0, 0, "", sv, NULL, NULL,
4993                       filename, linenumber, funcname);
4994 }
4995
4996 #endif /* PERL_MEM_LOG */
4997
4998 /*
4999 =for apidoc my_sprintf
5000
5001 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
5002 the length of the string written to the buffer.  Only rare pre-ANSI systems
5003 need the wrapper function - usually this is a direct call to C<sprintf>.
5004
5005 =cut
5006 */
5007 #ifndef SPRINTF_RETURNS_STRLEN
5008 int
5009 Perl_my_sprintf(char *buffer, const char* pat, ...)
5010 {
5011     va_list args;
5012     PERL_ARGS_ASSERT_MY_SPRINTF;
5013     va_start(args, pat);
5014     vsprintf(buffer, pat, args);
5015     va_end(args);
5016     return strlen(buffer);
5017 }
5018 #endif
5019
5020 /*
5021 =for apidoc quadmath_format_single
5022
5023 C<quadmath_snprintf()> is very strict about its C<format> string and will
5024 fail, returning -1, if the format is invalid.  It accepts exactly
5025 one format spec.
5026
5027 C<quadmath_format_single()> checks that the intended single spec looks
5028 sane: begins with C<%>, has only one C<%>, ends with C<[efgaEFGA]>,
5029 and has C<Q> before it.  This is not a full "printf syntax check",
5030 just the basics.
5031
5032 Returns the format if it is valid, NULL if not.
5033
5034 C<quadmath_format_single()> can and will actually patch in the missing
5035 C<Q>, if necessary.  In this case it will return the modified copy of
5036 the format, B<which the caller will need to free.>
5037
5038 See also L</quadmath_format_needed>.
5039
5040 =cut
5041 */
5042 #ifdef USE_QUADMATH
5043 const char*
5044 Perl_quadmath_format_single(const char* format)
5045 {
5046     STRLEN len;
5047
5048     PERL_ARGS_ASSERT_QUADMATH_FORMAT_SINGLE;
5049
5050     if (format[0] != '%' || strchr(format + 1, '%'))
5051         return NULL;
5052     len = strlen(format);
5053     /* minimum length three: %Qg */
5054     if (len < 3 || strchr("efgaEFGA", format[len - 1]) == NULL)
5055         return NULL;
5056     if (format[len - 2] != 'Q') {
5057         char* fixed;
5058         Newx(fixed, len + 1, char);
5059         memcpy(fixed, format, len - 1);
5060         fixed[len - 1] = 'Q';
5061         fixed[len    ] = format[len - 1];
5062         fixed[len + 1] = 0;
5063         return (const char*)fixed;
5064     }
5065     return format;
5066 }
5067 #endif
5068
5069 /*
5070 =for apidoc quadmath_format_needed
5071
5072 C<quadmath_format_needed()> returns true if the C<format> string seems to
5073 contain at least one non-Q-prefixed C<%[efgaEFGA]> format specifier,
5074 or returns false otherwise.
5075
5076 The format specifier detection is not complete printf-syntax detection,
5077 but it should catch most common cases.
5078
5079 If true is returned, those arguments B<should> in theory be processed
5080 with C<quadmath_snprintf()>, but in case there is more than one such
5081 format specifier (see L</quadmath_format_single>), and if there is
5082 anything else beyond that one (even just a single byte), they
5083 B<cannot> be processed because C<quadmath_snprintf()> is very strict,
5084 accepting only one format spec, and nothing else.
5085 In this case, the code should probably fail.
5086
5087 =cut
5088 */
5089 #ifdef USE_QUADMATH
5090 bool
5091 Perl_quadmath_format_needed(const char* format)
5092 {
5093   const char *p = format;
5094   const char *q;
5095
5096   PERL_ARGS_ASSERT_QUADMATH_FORMAT_NEEDED;
5097
5098   while ((q = strchr(p, '%'))) {
5099     q++;
5100     if (*q == '+') /* plus */
5101       q++;
5102     if (*q == '#') /* alt */
5103       q++;
5104     if (*q == '*') /* width */
5105       q++;
5106     else {
5107       if (isDIGIT(*q)) {
5108         while (isDIGIT(*q)) q++;
5109       }
5110     }
5111     if (*q == '.' && (q[1] == '*' || isDIGIT(q[1]))) { /* prec */
5112       q++;
5113       if (*q == '*')
5114         q++;
5115       else
5116         while (isDIGIT(*q)) q++;
5117     }
5118     if (strchr("efgaEFGA", *q)) /* Would have needed 'Q' in front. */
5119       return TRUE;
5120     p = q + 1;
5121   }
5122   return FALSE;
5123 }
5124 #endif
5125
5126 /*
5127 =for apidoc my_snprintf
5128
5129 The C library C<snprintf> functionality, if available and
5130 standards-compliant (uses C<vsnprintf>, actually).  However, if the
5131 C<vsnprintf> is not available, will unfortunately use the unsafe
5132 C<vsprintf> which can overrun the buffer (there is an overrun check,
5133 but that may be too late).  Consider using C<sv_vcatpvf> instead, or
5134 getting C<vsnprintf>.
5135
5136 =cut
5137 */
5138 int
5139 Perl_my_snprintf(char *buffer, const Size_t len, const char *format, ...)
5140 {
5141     int retval = -1;
5142     va_list ap;
5143     PERL_ARGS_ASSERT_MY_SNPRINTF;
5144 #ifndef HAS_VSNPRINTF
5145     PERL_UNUSED_VAR(len);
5146 #endif
5147     va_start(ap, format);
5148 #ifdef USE_QUADMATH
5149     {
5150         const char* qfmt = quadmath_format_single(format);
5151         bool quadmath_valid = FALSE;
5152         if (qfmt) {
5153             /* If the format looked promising, use it as quadmath. */
5154             retval = quadmath_snprintf(buffer, len, qfmt, va_arg(ap, NV));
5155             if (retval == -1) {
5156                 if (qfmt != format) {
5157                     dTHX;
5158                     SAVEFREEPV(qfmt);
5159                 }
5160                 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", qfmt);
5161             }
5162             quadmath_valid = TRUE;
5163             if (qfmt != format)
5164                 Safefree(qfmt);
5165             qfmt = NULL;
5166         }
5167         assert(qfmt == NULL);
5168         /* quadmath_format_single() will return false for example for
5169          * "foo = %g", or simply "%g".  We could handle the %g by
5170          * using quadmath for the NV args.  More complex cases of
5171          * course exist: "foo = %g, bar = %g", or "foo=%Qg" (otherwise
5172          * quadmath-valid but has stuff in front).
5173          *
5174          * Handling the "Q-less" cases right would require walking
5175          * through the va_list and rewriting the format, calling
5176          * quadmath for the NVs, building a new va_list, and then
5177          * letting vsnprintf/vsprintf to take care of the other
5178          * arguments.  This may be doable.
5179          *
5180          * We do not attempt that now.  But for paranoia, we here try
5181          * to detect some common (but not all) cases where the
5182          * "Q-less" %[efgaEFGA] formats are present, and die if
5183          * detected.  This doesn't fix the problem, but it stops the
5184          * vsnprintf/vsprintf pulling doubles off the va_list when
5185          * __float128 NVs should be pulled off instead.
5186          *
5187          * If quadmath_format_needed() returns false, we are reasonably
5188          * certain that we can call vnsprintf() or vsprintf() safely. */
5189         if (!quadmath_valid && quadmath_format_needed(format))
5190           Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5191
5192     }
5193 #endif
5194     if (retval == -1)
5195 #ifdef HAS_VSNPRINTF
5196         retval = vsnprintf(buffer, len, format, ap);
5197 #else
5198         retval = vsprintf(buffer, format, ap);
5199 #endif
5200     va_end(ap);
5201     /* vsprintf() shows failure with < 0 */
5202     if (retval < 0
5203 #ifdef HAS_VSNPRINTF
5204     /* vsnprintf() shows failure with >= len */
5205         ||
5206         (len > 0 && (Size_t)retval >= len)
5207 #endif
5208     )
5209         Perl_croak_nocontext("panic: my_snprintf buffer overflow");
5210     return retval;
5211 }
5212
5213 /*
5214 =for apidoc my_vsnprintf
5215
5216 The C library C<vsnprintf> if available and standards-compliant.
5217 However, if if the C<vsnprintf> is not available, will unfortunately
5218 use the unsafe C<vsprintf> which can overrun the buffer (there is an
5219 overrun check, but that may be too late).  Consider using
5220 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
5221
5222 =cut
5223 */
5224 int
5225 Perl_my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
5226 {
5227 #ifdef USE_QUADMATH
5228     PERL_UNUSED_ARG(buffer);
5229     PERL_UNUSED_ARG(len);
5230     PERL_UNUSED_ARG(format);
5231     /* the cast is to avoid gcc -Wsizeof-array-argument complaining */
5232     PERL_UNUSED_ARG((void*)ap);
5233     Perl_croak_nocontext("panic: my_vsnprintf not available with quadmath");
5234     return 0;
5235 #else
5236     int retval;
5237 #ifdef NEED_VA_COPY
5238     va_list apc;
5239
5240     PERL_ARGS_ASSERT_MY_VSNPRINTF;
5241     Perl_va_copy(ap, apc);
5242 # ifdef HAS_VSNPRINTF
5243     retval = vsnprintf(buffer, len, format, apc);
5244 # else
5245     PERL_UNUSED_ARG(len);
5246     retval = vsprintf(buffer, format, apc);
5247 # endif
5248     va_end(apc);
5249 #else
5250 # ifdef HAS_VSNPRINTF
5251     retval = vsnprintf(buffer, len, format, ap);
5252 # else
5253     PERL_UNUSED_ARG(len);
5254     retval = vsprintf(buffer, format, ap);
5255 # endif
5256 #endif /* #ifdef NEED_VA_COPY */
5257     /* vsprintf() shows failure with < 0 */
5258     if (retval < 0
5259 #ifdef HAS_VSNPRINTF
5260     /* vsnprintf() shows failure with >= len */
5261         ||
5262         (len > 0 && (Size_t)retval >= len)
5263 #endif
5264     )
5265         Perl_croak_nocontext("panic: my_vsnprintf buffer overflow");
5266     return retval;
5267 #endif
5268 }
5269
5270 void
5271 Perl_my_clearenv(pTHX)
5272 {
5273     dVAR;
5274 #if ! defined(PERL_MICRO)
5275 #  if defined(PERL_IMPLICIT_SYS) || defined(WIN32)
5276     PerlEnv_clearenv();
5277 #  else /* ! (PERL_IMPLICIT_SYS || WIN32) */
5278 #    if defined(USE_ENVIRON_ARRAY)
5279 #      if defined(USE_ITHREADS)
5280     /* only the parent thread can clobber the process environment */
5281     if (PL_curinterp == aTHX)
5282 #      endif /* USE_ITHREADS */
5283     {
5284 #      if ! defined(PERL_USE_SAFE_PUTENV)
5285     if ( !PL_use_safe_putenv) {
5286       I32 i;
5287       if (environ == PL_origenviron)
5288         environ = (char**)safesysmalloc(sizeof(char*));
5289       else
5290         for (i = 0; environ[i]; i++)
5291           (void)safesysfree(environ[i]);
5292     }
5293     environ[0] = NULL;
5294 #      else /* PERL_USE_SAFE_PUTENV */
5295 #        if defined(HAS_CLEARENV)
5296     (void)clearenv();
5297 #        elif defined(HAS_UNSETENV)
5298     int bsiz = 80; /* Most envvar names will be shorter than this. */
5299     char *buf = (char*)safesysmalloc(bsiz);
5300     while (*environ != NULL) {
5301       char *e = strchr(*environ, '=');
5302       int l = e ? e - *environ : (int)strlen(*environ);
5303       if (bsiz < l + 1) {
5304         (void)safesysfree(buf);
5305         bsiz = l + 1; /* + 1 for the \0. */
5306         buf = (char*)safesysmalloc(bsiz);
5307       }
5308       memcpy(buf, *environ, l);
5309       buf[l] = '\0';
5310       (void)unsetenv(buf);
5311     }
5312     (void)safesysfree(buf);
5313 #        else /* ! HAS_CLEARENV && ! HAS_UNSETENV */
5314     /* Just null environ and accept the leakage. */
5315     *environ = NULL;
5316 #        endif /* HAS_CLEARENV || HAS_UNSETENV */
5317 #      endif /* ! PERL_USE_SAFE_PUTENV */
5318     }
5319 #    endif /* USE_ENVIRON_ARRAY */
5320 #  endif /* PERL_IMPLICIT_SYS || WIN32 */
5321 #endif /* PERL_MICRO */
5322 }
5323
5324 #ifdef PERL_IMPLICIT_CONTEXT
5325
5326 /* Implements the MY_CXT_INIT macro. The first time a module is loaded,
5327 the global PL_my_cxt_index is incremented, and that value is assigned to
5328 that module's static my_cxt_index (who's address is passed as an arg).
5329 Then, for each interpreter this function is called for, it makes sure a
5330 void* slot is available to hang the static data off, by allocating or
5331 extending the interpreter's PL_my_cxt_list array */
5332
5333 #ifndef PERL_GLOBAL_STRUCT_PRIVATE
5334 void *
5335 Perl_my_cxt_init(pTHX_ int *index, size_t size)
5336 {
5337     dVAR;
5338     void *p;
5339     PERL_ARGS_ASSERT_MY_CXT_INIT;
5340     if (*index == -1) {
5341         /* this module hasn't been allocated an index yet */
5342         MUTEX_LOCK(&PL_my_ctx_mutex);
5343         *index = PL_my_cxt_index++;
5344         MUTEX_UNLOCK(&PL_my_ctx_mutex);
5345     }
5346
5347     /* make sure the array is big enough */
5348     if (PL_my_cxt_size <= *index) {
5349         if (PL_my_cxt_size) {
5350             IV new_size = PL_my_cxt_size;
5351             while (new_size <= *index)
5352                 new_size *= 2;
5353             Renew(PL_my_cxt_list, new_size, void *);
5354             PL_my_cxt_size = new_size;
5355         }
5356         else {
5357             PL_my_cxt_size = 16;
5358             Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5359         }
5360     }
5361     /* newSV() allocates one more than needed */
5362     p = (void*)SvPVX(newSV(size-1));
5363     PL_my_cxt_list[*index] = p;
5364     Zero(p, size, char);
5365     return p;
5366 }
5367
5368 #else /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5369
5370 int
5371 Perl_my_cxt_index(pTHX_ const char *my_cxt_key)
5372 {
5373     dVAR;
5374     int index;
5375
5376     PERL_ARGS_ASSERT_MY_CXT_INDEX;
5377
5378     for (index = 0; index < PL_my_cxt_index; index++) {
5379         const char *key = PL_my_cxt_keys[index];
5380         /* try direct pointer compare first - there are chances to success,
5381          * and it's much faster.
5382          */
5383         if ((key == my_cxt_key) || strEQ(key, my_cxt_key))
5384             return index;
5385     }
5386     return -1;
5387 }
5388
5389 void *
5390 Perl_my_cxt_init(pTHX_ const char *my_cxt_key, size_t size)
5391 {
5392     dVAR;
5393     void *p;
5394     int index;
5395
5396     PERL_ARGS_ASSERT_MY_CXT_INIT;
5397
5398     index = Perl_my_cxt_index(aTHX_ my_cxt_key);
5399     if (index == -1) {
5400         /* this module hasn't been allocated an index yet */
5401         MUTEX_LOCK(&PL_my_ctx_mutex);
5402         index = PL_my_cxt_index++;
5403         MUTEX_UNLOCK(&PL_my_ctx_mutex);
5404     }
5405
5406     /* make sure the array is big enough */
5407     if (PL_my_cxt_size <= index) {
5408         int old_size = PL_my_cxt_size;
5409         int i;
5410         if (PL_my_cxt_size) {
5411             IV new_size = PL_my_cxt_size;
5412             while (new_size <= index)
5413                 new_size *= 2;
5414             Renew(PL_my_cxt_list, new_size, void *);
5415             Renew(PL_my_cxt_keys, new_size, const char *);
5416             PL_my_cxt_size = new_size;
5417         }
5418         else {
5419             PL_my_cxt_size = 16;
5420             Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5421             Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
5422         }
5423         for (i = old_size; i < PL_my_cxt_size; i++) {
5424             PL_my_cxt_keys[i] = 0;
5425             PL_my_cxt_list[i] = 0;
5426         }
5427     }
5428     PL_my_cxt_keys[index] = my_cxt_key;
5429     /* newSV() allocates one more than needed */
5430     p = (void*)SvPVX(newSV(size-1));
5431     PL_my_cxt_list[index] = p;
5432     Zero(p, size, char);
5433     return p;
5434 }
5435 #endif /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5436 #endif /* PERL_IMPLICIT_CONTEXT */
5437
5438
5439 /* Perl_xs_handshake():
5440    implement the various XS_*_BOOTCHECK macros, which are added to .c
5441    files by ExtUtils::ParseXS, to check that the perl the module was built
5442    with is binary compatible with the running perl.
5443
5444    usage:
5445        Perl_xs_handshake(U32 key, void * v_my_perl, const char * file,
5446             [U32 items, U32 ax], [char * api_version], [char * xs_version])
5447
5448    The meaning of the varargs is determined the U32 key arg (which is not
5449    a format string). The fields of key are assembled by using HS_KEY().
5450
5451    Under PERL_IMPLICIT_CONTEX, the v_my_perl arg is of type
5452    "PerlInterpreter *" and represents the callers context; otherwise it is
5453    of type "CV *", and is the boot xsub's CV.
5454
5455    v_my_perl will catch where a threaded future perl526.dll calling IO.dll
5456    for example, and IO.dll was linked with threaded perl524.dll, and both
5457    perl526.dll and perl524.dll are in %PATH and the Win32 DLL loader
5458    successfully can load IO.dll into the process but simultaneously it
5459    loaded an interpreter of a different version into the process, and XS
5460    code will naturally pass SV*s created by perl524.dll for perl526.dll to
5461    use through perl526.dll's my_perl->Istack_base.
5462
5463    v_my_perl cannot be the first arg, since then 'key' will be out of
5464    place in a threaded vs non-threaded mixup; and analyzing the key
5465    number's bitfields won't reveal the problem, since it will be a valid
5466    key (unthreaded perl) on interp side, but croak will report the XS mod's
5467    key as gibberish (it is really a my_perl ptr) (threaded XS mod); or if
5468    it's a threaded perl and an unthreaded XS module, threaded perl will
5469    look at an uninit C stack or an uninit register to get 'key'
5470    (remember that it assumes that the 1st arg is the interp cxt).
5471
5472    'file' is the source filename of the caller.
5473 */
5474
5475 I32
5476 Perl_xs_handshake(const U32 key, void * v_my_perl, const char * file, ...)
5477 {
5478     va_list args;
5479     U32 items, ax;
5480     void * got;
5481     void * need;
5482 #ifdef PERL_IMPLICIT_CONTEXT
5483     dTHX;
5484     tTHX xs_interp;
5485 #else
5486     CV* cv;
5487     SV *** xs_spp;
5488 #endif
5489     PERL_ARGS_ASSERT_XS_HANDSHAKE;
5490     va_start(args, file);
5491
5492     got = INT2PTR(void*, (UV)(key & HSm_KEY_MATCH));
5493     need = (void *)(HS_KEY(FALSE, FALSE, "", "") & HSm_KEY_MATCH);
5494     if (UNLIKELY(got != need))
5495         goto bad_handshake;
5496 /* try to catch where a 2nd threaded perl interp DLL is loaded into a process
5497    by a XS DLL compiled against the wrong interl DLL b/c of bad @INC, and the
5498    2nd threaded perl interp DLL never initialized its TLS/PERL_SYS_INIT3 so
5499    dTHX call from 2nd interp DLL can't return the my_perl that pp_entersub
5500    passed to the XS DLL */
5501 #ifdef PERL_IMPLICIT_CONTEXT
5502     xs_interp = (tTHX)v_my_perl;
5503     got = xs_interp;
5504     need = my_perl;
5505 #else
5506 /* try to catch where an unthreaded perl interp DLL (for ex. perl522.dll) is
5507    loaded into a process by a XS DLL built by an unthreaded perl522.dll perl,
5508    but the DynaLoder/Perl that started the process and loaded the XS DLL is
5509    unthreaded perl524.dll, since unthreadeds don't pass my_perl (a unique *)
5510    through pp_entersub, use a unique value (which is a pointer to PL_stack_sp's
5511    location in the unthreaded perl binary) stored in CV * to figure out if this
5512    Perl_xs_handshake was called by the same pp_entersub */
5513     cv = (CV*)v_my_perl;
5514     xs_spp = (SV***)CvHSCXT(cv);
5515     got = xs_spp;
5516     need = &PL_stack_sp;
5517 #endif
5518     if(UNLIKELY(got != need)) {
5519         bad_handshake:/* recycle branch and string from above */
5520         if(got != (void *)HSf_NOCHK)
5521             noperl_die("%s: loadable library and perl binaries are mismatched"
5522                        " (got handshake key %p, needed %p)\n",
5523                 file, got, need);
5524     }
5525
5526     if(key & HSf_SETXSUBFN) {     /* this might be called from a module bootstrap */
5527         SAVEPPTR(PL_xsubfilename);/* which was require'd from a XSUB BEGIN */
5528         PL_xsubfilename = file;   /* so the old name must be restored for
5529                                      additional XSUBs to register themselves */
5530         /* XSUBs can't be perl lang/perl5db.pl debugged
5531         if (PERLDB_LINE_OR_SAVESRC)
5532             (void)gv_fetchfile(file); */
5533     }
5534
5535     if(key & HSf_POPMARK) {
5536         ax = POPMARK;
5537         {   SV **mark = PL_stack_base + ax++;
5538             {   dSP;
5539                 items = (I32)(SP - MARK);
5540             }
5541         }
5542     } else {
5543         items = va_arg(args, U32);
5544         ax = va_arg(args, U32);
5545     }
5546     {
5547         U32 apiverlen;
5548         assert(HS_GETAPIVERLEN(key) <= UCHAR_MAX);
5549         if((apiverlen = HS_GETAPIVERLEN(key))) {
5550             char * api_p = va_arg(args, char*);
5551             if(apiverlen != sizeof("v" PERL_API_VERSION_STRING)-1
5552                 || memNE(api_p, "v" PERL_API_VERSION_STRING,
5553                          sizeof("v" PERL_API_VERSION_STRING)-1))
5554                 Perl_croak_nocontext("Perl API version %s of %" SVf " does not match %s",
5555                                     api_p, SVfARG(PL_stack_base[ax + 0]),
5556                                     "v" PERL_API_VERSION_STRING);
5557         }
5558     }
5559     {
5560         U32 xsverlen;
5561         assert(HS_GETXSVERLEN(key) <= UCHAR_MAX && HS_GETXSVERLEN(key) <= HS_APIVERLEN_MAX);
5562         if((xsverlen = HS_GETXSVERLEN(key)))
5563             S_xs_version_bootcheck(aTHX_
5564                 items, ax, va_arg(args, char*), xsverlen);
5565     }
5566     va_end(args);
5567     return ax;
5568 }
5569
5570
5571 STATIC void
5572 S_xs_version_bootcheck(pTHX_ U32 items, U32 ax, const char *xs_p,
5573                           STRLEN xs_len)
5574 {
5575     SV *sv;
5576     const char *vn = NULL;
5577     SV *const module = PL_stack_base[ax];
5578
5579     PERL_ARGS_ASSERT_XS_VERSION_BOOTCHECK;
5580
5581     if (items >= 2)      /* version supplied as bootstrap arg */
5582         sv = PL_stack_base[ax + 1];
5583     else {
5584         /* XXX GV_ADDWARN */
5585         vn = "XS_VERSION";
5586         sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5587         if (!sv || !SvOK(sv)) {
5588             vn = "VERSION";
5589             sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5590         }
5591     }
5592     if (sv) {
5593         SV *xssv = Perl_newSVpvn_flags(aTHX_ xs_p, xs_len, SVs_TEMP);
5594         SV *pmsv = sv_isobject(sv) && sv_derived_from(sv, "version")
5595             ? sv : sv_2mortal(new_version(sv));
5596         xssv = upg_version(xssv, 0);
5597         if ( vcmp(pmsv,xssv) ) {
5598             SV *string = vstringify(xssv);
5599             SV *xpt = Perl_newSVpvf(aTHX_ "%" SVf " object version %" SVf
5600                                     " does not match ", SVfARG(module), SVfARG(string));
5601
5602             SvREFCNT_dec(string);
5603             string = vstringify(pmsv);
5604
5605             if (vn) {
5606                 Perl_sv_catpvf(aTHX_ xpt, "$%" SVf "::%s %" SVf, SVfARG(module), vn,
5607                                SVfARG(string));
5608             } else {
5609                 Perl_sv_catpvf(aTHX_ xpt, "bootstrap parameter %" SVf, SVfARG(string));
5610             }
5611             SvREFCNT_dec(string);
5612
5613             Perl_sv_2mortal(aTHX_ xpt);
5614             Perl_croak_sv(aTHX_ xpt);
5615         }
5616     }
5617 }
5618
5619 /*
5620 =for apidoc my_strlcat
5621
5622 The C library C<strlcat> if available, or a Perl implementation of it.
5623 This operates on C C<NUL>-terminated strings.
5624
5625 C<my_strlcat()> appends string C<src> to the end of C<dst>.  It will append at
5626 most S<C<size - strlen(dst) - 1>> characters.  It will then C<NUL>-terminate,
5627 unless C<size> is 0 or the original C<dst> string was longer than C<size> (in
5628 practice this should not happen as it means that either C<size> is incorrect or
5629 that C<dst> is not a proper C<NUL>-terminated string).
5630
5631 Note that C<size> is the full size of the destination buffer and
5632 the result is guaranteed to be C<NUL>-terminated if there is room.  Note that
5633 room for the C<NUL> should be included in C<size>.
5634
5635 The return value is the total length that C<dst> would have if C<size> is
5636 sufficiently large.  Thus it is the initial length of C<dst> plus the length of
5637 C<src>.  If C<size> is smaller than the return, the excess was not appended.
5638
5639 =cut
5640
5641 Description stolen from http://man.openbsd.org/strlcat.3
5642 */
5643 #ifndef HAS_STRLCAT
5644 Size_t
5645 Perl_my_strlcat(char *dst, const char *src, Size_t size)
5646 {
5647     Size_t used, length, copy;
5648
5649     used = strlen(dst);
5650     length = strlen(src);
5651     if (size > 0 && used < size - 1) {
5652         copy = (length >= size - used) ? size - used - 1 : length;
5653         memcpy(dst + used, src, copy);
5654         dst[used + copy] = '\0';
5655     }
5656     return used + length;
5657 }
5658 #endif
5659
5660
5661 /*
5662 =for apidoc my_strlcpy
5663
5664 The C library C<strlcpy> if available, or a Perl implementation of it.
5665 This operates on C C<NUL>-terminated strings.
5666
5667 C<my_strlcpy()> copies up to S<C<size - 1>> characters from the string C<src>
5668 to C<dst>, C<NUL>-terminating the result if C<size> is not 0.
5669
5670 The return value is the total length C<src> would be if the copy completely
5671 succeeded.  If it is larger than C<size>, the excess was not copied.
5672
5673 =cut
5674
5675 Description stolen from http://man.openbsd.org/strlcpy.3
5676 */
5677 #ifndef HAS_STRLCPY
5678 Size_t
5679 Perl_my_strlcpy(char *dst, const char *src, Size_t size)
5680 {
5681     Size_t length, copy;
5682
5683     length = strlen(src);
5684     if (size > 0) {
5685         copy = (length >= size) ? size - 1 : length;
5686         memcpy(dst, src, copy);
5687         dst[copy] = '\0';
5688     }
5689     return length;
5690 }
5691 #endif
5692
5693 #if defined(_MSC_VER) && (_MSC_VER >= 1300) && (_MSC_VER < 1400) && (WINVER < 0x0500)
5694 /* VC7 or 7.1, building with pre-VC7 runtime libraries. */
5695 long _ftol( double ); /* Defined by VC6 C libs. */
5696 long _ftol2( double dblSource ) { return _ftol( dblSource ); }
5697 #endif
5698
5699 PERL_STATIC_INLINE bool
5700 S_gv_has_usable_name(pTHX_ GV *gv)
5701 {
5702     GV **gvp;
5703     return GvSTASH(gv)
5704         && HvENAME(GvSTASH(gv))
5705         && (gvp = (GV **)hv_fetchhek(
5706                         GvSTASH(gv), GvNAME_HEK(gv), 0
5707            ))
5708         && *gvp == gv;
5709 }
5710
5711 void
5712 Perl_get_db_sub(pTHX_ SV **svp, CV *cv)
5713 {
5714     SV * const dbsv = GvSVn(PL_DBsub);
5715     const bool save_taint = TAINT_get;
5716
5717     /* When we are called from pp_goto (svp is null),
5718      * we do not care about using dbsv to call CV;
5719      * it's for informational purposes only.
5720      */
5721
5722     PERL_ARGS_ASSERT_GET_DB_SUB;
5723
5724     TAINT_set(FALSE);
5725     save_item(dbsv);
5726     if (!PERLDB_SUB_NN) {
5727         GV *gv = CvGV(cv);
5728
5729         if (!svp && !CvLEXICAL(cv)) {
5730             gv_efullname3(dbsv, gv, NULL);
5731         }
5732         else if ( (CvFLAGS(cv) & (CVf_ANON | CVf_CLONED)) || CvLEXICAL(cv)
5733              || strEQ(GvNAME(gv), "END")
5734              || ( /* Could be imported, and old sub redefined. */
5735                  (GvCV(gv) != cv || !S_gv_has_usable_name(aTHX_ gv))
5736                  &&
5737                  !( (SvTYPE(*svp) == SVt_PVGV)
5738                     && (GvCV((const GV *)*svp) == cv)
5739                     /* Use GV from the stack as a fallback. */
5740                     && S_gv_has_usable_name(aTHX_ gv = (GV *)*svp)
5741                   )
5742                 )
5743         ) {
5744             /* GV is potentially non-unique, or contain different CV. */
5745             SV * const tmp = newRV(MUTABLE_SV(cv));
5746             sv_setsv(dbsv, tmp);
5747             SvREFCNT_dec(tmp);
5748         }
5749         else {
5750             sv_sethek(dbsv, HvENAME_HEK(GvSTASH(gv)));
5751             sv_catpvs(dbsv, "::");
5752             sv_cathek(dbsv, GvNAME_HEK(gv));
5753         }
5754     }
5755     else {
5756         const int type = SvTYPE(dbsv);
5757         if (type < SVt_PVIV && type != SVt_IV)
5758             sv_upgrade(dbsv, SVt_PVIV);
5759         (void)SvIOK_on(dbsv);
5760         SvIV_set(dbsv, PTR2IV(cv));     /* Do it the quickest way  */
5761     }
5762     SvSETMAGIC(dbsv);
5763     TAINT_IF(save_taint);
5764 #ifdef NO_TAINT_SUPPORT
5765     PERL_UNUSED_VAR(save_taint);
5766 #endif
5767 }
5768
5769 int
5770 Perl_my_dirfd(DIR * dir) {
5771
5772     /* Most dirfd implementations have problems when passed NULL. */
5773     if(!dir)
5774         return -1;
5775 #ifdef HAS_DIRFD
5776     return dirfd(dir);
5777 #elif defined(HAS_DIR_DD_FD)
5778     return dir->dd_fd;
5779 #else
5780     Perl_croak_nocontext(PL_no_func, "dirfd");
5781     NOT_REACHED; /* NOTREACHED */
5782     return 0;
5783 #endif
5784 }
5785
5786 REGEXP *
5787 Perl_get_re_arg(pTHX_ SV *sv) {
5788
5789     if (sv) {
5790         if (SvMAGICAL(sv))
5791             mg_get(sv);
5792         if (SvROK(sv))
5793             sv = MUTABLE_SV(SvRV(sv));
5794         if (SvTYPE(sv) == SVt_REGEXP)
5795             return (REGEXP*) sv;
5796     }
5797
5798     return NULL;
5799 }
5800
5801 /*
5802  * This code is derived from drand48() implementation from FreeBSD,
5803  * found in lib/libc/gen/_rand48.c.
5804  *
5805  * The U64 implementation is original, based on the POSIX
5806  * specification for drand48().
5807  */
5808
5809 /*
5810 * Copyright (c) 1993 Martin Birgmeier
5811 * All rights reserved.
5812 *
5813 * You may redistribute unmodified or modified versions of this source
5814 * code provided that the above copyright notice and this and the
5815 * following conditions are retained.
5816 *
5817 * This software is provided ``as is'', and comes with no warranties
5818 * of any kind. I shall in no event be liable for anything that happens
5819 * to anyone/anything when using this software.
5820 */
5821
5822 #define FREEBSD_DRAND48_SEED_0   (0x330e)
5823
5824 #ifdef PERL_DRAND48_QUAD
5825
5826 #define DRAND48_MULT U64_CONST(0x5deece66d)
5827 #define DRAND48_ADD  0xb
5828 #define DRAND48_MASK U64_CONST(0xffffffffffff)
5829
5830 #else
5831
5832 #define FREEBSD_DRAND48_SEED_1   (0xabcd)
5833 #define FREEBSD_DRAND48_SEED_2   (0x1234)
5834 #define FREEBSD_DRAND48_MULT_0   (0xe66d)
5835 #define FREEBSD_DRAND48_MULT_1   (0xdeec)
5836 #define FREEBSD_DRAND48_MULT_2   (0x0005)
5837 #define FREEBSD_DRAND48_ADD      (0x000b)
5838
5839 const unsigned short _rand48_mult[3] = {
5840                 FREEBSD_DRAND48_MULT_0,
5841                 FREEBSD_DRAND48_MULT_1,
5842                 FREEBSD_DRAND48_MULT_2
5843 };
5844 const unsigned short _rand48_add = FREEBSD_DRAND48_ADD;
5845
5846 #endif
5847
5848 void
5849 Perl_drand48_init_r(perl_drand48_t *random_state, U32 seed)
5850 {
5851     PERL_ARGS_ASSERT_DRAND48_INIT_R;
5852
5853 #ifdef PERL_DRAND48_QUAD
5854     *random_state = FREEBSD_DRAND48_SEED_0 + ((U64)seed << 16);
5855 #else
5856     random_state->seed[0] = FREEBSD_DRAND48_SEED_0;
5857     random_state->seed[1] = (U16) seed;
5858     random_state->seed[2] = (U16) (seed >> 16);
5859 #endif
5860 }
5861
5862 double
5863 Perl_drand48_r(perl_drand48_t *random_state)
5864 {
5865     PERL_ARGS_ASSERT_DRAND48_R;
5866
5867 #ifdef PERL_DRAND48_QUAD
5868     *random_state = (*random_state * DRAND48_MULT + DRAND48_ADD)
5869         & DRAND48_MASK;
5870
5871     return ldexp((double)*random_state, -48);
5872 #else
5873     {
5874     U32 accu;
5875     U16 temp[2];
5876
5877     accu = (U32) _rand48_mult[0] * (U32) random_state->seed[0]
5878          + (U32) _rand48_add;
5879     temp[0] = (U16) accu;        /* lower 16 bits */
5880     accu >>= sizeof(U16) * 8;
5881     accu += (U32) _rand48_mult[0] * (U32) random_state->seed[1]
5882           + (U32) _rand48_mult[1] * (U32) random_state->seed[0];
5883     temp[1] = (U16) accu;        /* middle 16 bits */
5884     accu >>= sizeof(U16) * 8;
5885     accu += _rand48_mult[0] * random_state->seed[2]
5886           + _rand48_mult[1] * random_state->seed[1]
5887           + _rand48_mult[2] * random_state->seed[0];
5888     random_state->seed[0] = temp[0];
5889     random_state->seed[1] = temp[1];
5890     random_state->seed[2] = (U16) accu;
5891
5892     return ldexp((double) random_state->seed[0], -48) +
5893            ldexp((double) random_state->seed[1], -32) +
5894            ldexp((double) random_state->seed[2], -16);
5895     }
5896 #endif
5897 }
5898
5899 #ifdef USE_C_BACKTRACE
5900
5901 /* Possibly move all this USE_C_BACKTRACE code into a new file. */
5902
5903 #ifdef USE_BFD
5904
5905 typedef struct {
5906     /* abfd is the BFD handle. */
5907     bfd* abfd;
5908     /* bfd_syms is the BFD symbol table. */
5909     asymbol** bfd_syms;
5910     /* bfd_text is handle to the the ".text" section of the object file. */
5911     asection* bfd_text;
5912     /* Since opening the executable and scanning its symbols is quite
5913      * heavy operation, we remember the filename we used the last time,
5914      * and do the opening and scanning only if the filename changes.
5915      * This removes most (but not all) open+scan cycles. */
5916     const char* fname_prev;
5917 } bfd_context;
5918
5919 /* Given a dl_info, update the BFD context if necessary. */
5920 static void bfd_update(bfd_context* ctx, Dl_info* dl_info)
5921 {
5922     /* BFD open and scan only if the filename changed. */
5923     if (ctx->fname_prev == NULL ||
5924         strNE(dl_info->dli_fname, ctx->fname_prev)) {
5925         if (ctx->abfd) {
5926             bfd_close(ctx->abfd);
5927         }
5928         ctx->abfd = bfd_openr(dl_info->dli_fname, 0);
5929         if (ctx->abfd) {
5930             if (bfd_check_format(ctx->abfd, bfd_object)) {
5931                 IV symbol_size = bfd_get_symtab_upper_bound(ctx->abfd);
5932                 if (symbol_size > 0) {
5933                     Safefree(ctx->bfd_syms);
5934                     Newx(ctx->bfd_syms, symbol_size, asymbol*);
5935                     ctx->bfd_text =
5936                         bfd_get_section_by_name(ctx->abfd, ".text");
5937                 }
5938                 else
5939                     ctx->abfd = NULL;
5940             }
5941             else
5942                 ctx->abfd = NULL;
5943         }
5944         ctx->fname_prev = dl_info->dli_fname;
5945     }
5946 }
5947
5948 /* Given a raw frame, try to symbolize it and store
5949  * symbol information (source file, line number) away. */
5950 static void bfd_symbolize(bfd_context* ctx,
5951                           void* raw_frame,
5952                           char** symbol_name,
5953                           STRLEN* symbol_name_size,
5954                           char** source_name,
5955                           STRLEN* source_name_size,
5956                           STRLEN* source_line)
5957 {
5958     *symbol_name = NULL;
5959     *symbol_name_size = 0;
5960     if (ctx->abfd) {
5961         IV offset = PTR2IV(raw_frame) - PTR2IV(ctx->bfd_text->vma);
5962         if (offset > 0 &&
5963             bfd_canonicalize_symtab(ctx->abfd, ctx->bfd_syms) > 0) {
5964             const char *file;
5965             const char *func;
5966             unsigned int line = 0;
5967             if (bfd_find_nearest_line(ctx->abfd, ctx->bfd_text,
5968                                       ctx->bfd_syms, offset,
5969                                       &file, &func, &line) &&
5970                 file && func && line > 0) {
5971                 /* Size and copy the source file, use only
5972                  * the basename of the source file.
5973                  *
5974                  * NOTE: the basenames are fine for the
5975                  * Perl source files, but may not always
5976                  * be the best idea for XS files. */
5977                 const char *p, *b = NULL;
5978                 /* Look for the last slash. */
5979                 for (p = file; *p; p++) {
5980                     if (*p == '/')
5981                         b = p + 1;
5982                 }
5983                 if (b == NULL || *b == 0) {
5984                     b = file;
5985                 }
5986                 *source_name_size = p - b + 1;
5987                 Newx(*source_name, *source_name_size + 1, char);
5988                 Copy(b, *source_name, *source_name_size + 1, char);
5989
5990                 *symbol_name_size = strlen(func);
5991                 Newx(*symbol_name, *symbol_name_size + 1, char);
5992                 Copy(func, *symbol_name, *symbol_name_size + 1, char);
5993
5994                 *source_line = line;
5995             }
5996         }
5997     }
5998 }
5999
6000 #endif /* #ifdef USE_BFD */
6001
6002 #ifdef PERL_DARWIN
6003
6004 /* OS X has no public API for for 'symbolicating' (Apple official term)
6005  * stack addresses to {function_name, source_file, line_number}.
6006  * Good news: there is command line utility atos(1) which does that.
6007  * Bad news 1: it's a command line utility.
6008  * Bad news 2: one needs to have the Developer Tools installed.
6009  * Bad news 3: in newer releases it needs to be run as 'xcrun atos'.
6010  *
6011  * To recap: we need to open a pipe for reading for a utility which
6012  * might not exist, or exists in different locations, and then parse
6013  * the output.  And since this is all for a low-level API, we cannot
6014  * use high-level stuff.  Thanks, Apple. */
6015
6016 typedef struct {
6017     /* tool is set to the absolute pathname of the tool to use:
6018      * xcrun or atos. */
6019     const char* tool;
6020     /* format is set to a printf format string used for building
6021      * the external command to run. */
6022     const char* format;
6023     /* unavail is set if e.g. xcrun cannot be found, or something
6024      * else happens that makes getting the backtrace dubious.  Note,
6025      * however, that the context isn't persistent, the next call to
6026      * get_c_backtrace() will start from scratch. */
6027     bool unavail;
6028     /* fname is the current object file name. */
6029     const char* fname;
6030     /* object_base_addr is the base address of the shared object. */
6031     void* object_base_addr;
6032 } atos_context;
6033
6034 /* Given |dl_info|, updates the context.  If the context has been
6035  * marked unavailable, return immediately.  If not but the tool has
6036  * not been set, set it to either "xcrun atos" or "atos" (also set the
6037  * format to use for creating commands for piping), or if neither is
6038  * unavailable (one needs the Developer Tools installed), mark the context
6039  * an unavailable.  Finally, update the filename (object name),
6040  * and its base address. */
6041
6042 static void atos_update(atos_context* ctx,
6043                         Dl_info* dl_info)
6044 {
6045     if (ctx->unavail)
6046         return;
6047     if (ctx->tool == NULL) {
6048         const char* tools[] = {
6049             "/usr/bin/xcrun",
6050             "/usr/bin/atos"
6051         };
6052         const char* formats[] = {
6053             "/usr/bin/xcrun atos -o '%s' -l %08x %08x 2>&1",
6054             "/usr/bin/atos -d -o '%s' -l %08x %08x 2>&1"
6055         };
6056         struct stat st;
6057         UV i;
6058         for (i = 0; i < C_ARRAY_LENGTH(tools); i++) {
6059             if (stat(tools[i], &st) == 0 && S_ISREG(st.st_mode)) {
6060                 ctx->tool = tools[i];
6061                 ctx->format = formats[i];
6062                 break;
6063             }
6064         }
6065         if (ctx->tool == NULL) {
6066             ctx->unavail = TRUE;
6067             return;
6068         }
6069     }
6070     if (ctx->fname == NULL ||
6071         strNE(dl_info->dli_fname, ctx->fname)) {
6072         ctx->fname = dl_info->dli_fname;
6073         ctx->object_base_addr = dl_info->dli_fbase;
6074     }
6075 }
6076
6077 /* Given an output buffer end |p| and its |start|, matches
6078  * for the atos output, extracting the source code location
6079  * and returning non-NULL if possible, returning NULL otherwise. */
6080 static const char* atos_parse(const char* p,
6081                               const char* start,
6082                               STRLEN* source_name_size,
6083                               STRLEN* source_line) {
6084     /* atos() output is something like:
6085      * perl_parse (in miniperl) (perl.c:2314)\n\n".
6086      * We cannot use Perl regular expressions, because we need to
6087      * stay low-level.  Therefore here we have a rolled-out version
6088      * of a state machine which matches _backwards_from_the_end_ and
6089      * if there's a success, returns the starts of the filename,
6090      * also setting the filename size and the source line number.
6091      * The matched regular expression is roughly "\(.*:\d+\)\s*$" */
6092     const char* source_number_start;
6093     const char* source_name_end;
6094     const char* source_line_end;
6095     const char* close_paren;
6096     UV uv;
6097
6098     /* Skip trailing whitespace. */
6099     while (p > start && isspace(*p)) p--;
6100     /* Now we should be at the close paren. */
6101     if (p == start || *p != ')')
6102         return NULL;
6103     close_paren = p;
6104     p--;
6105     /* Now we should be in the line number. */
6106     if (p == start || !isdigit(*p))
6107         return NULL;
6108     /* Skip over the digits. */
6109     while (p > start && isdigit(*p))
6110         p--;
6111     /* Now we should be at the colon. */
6112     if (p == start || *p != ':')
6113         return NULL;
6114     source_number_start = p + 1;
6115     source_name_end = p; /* Just beyond the end. */
6116     p--;
6117     /* Look for the open paren. */
6118     while (p > start && *p != '(')
6119         p--;
6120     if (p == start)
6121         return NULL;
6122     p++;
6123     *source_name_size = source_name_end - p;
6124     if (grok_atoUV(source_number_start, &uv,  &source_line_end)
6125         && source_line_end == close_paren
6126         && uv <= PERL_INT_MAX
6127     ) {
6128         *source_line = (STRLEN)uv;
6129         return p;
6130     }
6131     return NULL;
6132 }
6133
6134 /* Given a raw frame, read a pipe from the symbolicator (that's the
6135  * technical term) atos, reads the result, and parses the source code
6136  * location.  We must stay low-level, so we use snprintf(), pipe(),
6137  * and fread(), and then also parse the output ourselves. */
6138 static void atos_symbolize(atos_context* ctx,
6139                            void* raw_frame,
6140                            char** source_name,
6141                            STRLEN* source_name_size,
6142                            STRLEN* source_line)
6143 {
6144     char cmd[1024];
6145     const char* p;
6146     Size_t cnt;
6147
6148     if (ctx->unavail)
6149         return;
6150     /* Simple security measure: if there's any funny business with
6151      * the object name (used as "-o '%s'" ), leave since at least
6152      * partially the user controls it. */
6153     for (p = ctx->fname; *p; p++) {
6154         if (*p == '\'' || iscntrl(*p)) {
6155             ctx->unavail = TRUE;
6156             return;
6157         }
6158     }
6159     cnt = snprintf(cmd, sizeof(cmd), ctx->format,
6160                    ctx->fname, ctx->object_base_addr, raw_frame);
6161     if (cnt < sizeof(cmd)) {
6162         /* Undo nostdio.h #defines that disable stdio.
6163          * This is somewhat naughty, but is used elsewhere
6164          * in the core, and affects only OS X. */
6165 #undef FILE
6166 #undef popen
6167 #undef fread
6168 #undef pclose
6169         FILE* fp = popen(cmd, "r");
6170         /* At the moment we open a new pipe for each stack frame.
6171          * This is naturally somewhat slow, but hopefully generating
6172          * stack traces is never going to in a performance critical path.
6173          *
6174          * We could play tricks with atos by batching the stack
6175          * addresses to be resolved: atos can either take multiple
6176          * addresses from the command line, or read addresses from
6177          * a file (though the mess of creating temporary files would
6178          * probably negate much of any possible speedup).
6179          *
6180          * Normally there are only two objects present in the backtrace:
6181          * perl itself, and the libdyld.dylib.  (Note that the object
6182          * filenames contain the full pathname, so perl may not always
6183          * be in the same place.)  Whenever the object in the
6184          * backtrace changes, the base address also changes.
6185          *
6186          * The problem with batching the addresses, though, would be
6187          * matching the results with the addresses: the parsing of
6188          * the results is already painful enough with a single address. */
6189         if (fp) {
6190             char out[1024];
6191             UV cnt = fread(out, 1, sizeof(out), fp);
6192             if (cnt < sizeof(out)) {
6193                 const char* p = atos_parse(out + cnt - 1, out,
6194                                            source_name_size,
6195                                            source_line);
6196                 if (p) {
6197                     Newx(*source_name,
6198                          *source_name_size, char);
6199                     Copy(p, *source_name,
6200                          *source_name_size,  char);
6201                 }
6202             }
6203             pclose(fp);
6204         }
6205     }
6206 }
6207
6208 #endif /* #ifdef PERL_DARWIN */
6209
6210 /*
6211 =for apidoc get_c_backtrace
6212
6213 Collects the backtrace (aka "stacktrace") into a single linear
6214 malloced buffer, which the caller B<must> C<Perl_free_c_backtrace()>.
6215
6216 Scans the frames back by S<C<depth + skip>>, then drops the C<skip> innermost,
6217 returning at most C<depth> frames.
6218
6219 =cut
6220 */
6221
6222 Perl_c_backtrace*
6223 Perl_get_c_backtrace(pTHX_ int depth, int skip)
6224 {
6225     /* Note that here we must stay as low-level as possible: Newx(),
6226      * Copy(), Safefree(); since we may be called from anywhere,
6227      * so we should avoid higher level constructs like SVs or AVs.
6228      *
6229      * Since we are using safesysmalloc() via Newx(), don't try
6230      * getting backtrace() there, unless you like deep recursion. */
6231
6232     /* Currently only implemented with backtrace() and dladdr(),
6233      * for other platforms NULL is returned. */
6234
6235 #if defined(HAS_BACKTRACE) && defined(HAS_DLADDR)
6236     /* backtrace() is available via <execinfo.h> in glibc and in most
6237      * modern BSDs; dladdr() is available via <dlfcn.h>. */
6238
6239     /* We try fetching this many frames total, but then discard
6240      * the |skip| first ones.  For the remaining ones we will try
6241      * retrieving more information with dladdr(). */
6242     int try_depth = skip +  depth;
6243
6244     /* The addresses (program counters) returned by backtrace(). */
6245     void** raw_frames;
6246
6247     /* Retrieved with dladdr() from the addresses returned by backtrace(). */
6248     Dl_info* dl_infos;
6249
6250     /* Sizes _including_ the terminating \0 of the object name
6251      * and symbol name strings. */
6252     STRLEN* object_name_sizes;
6253     STRLEN* symbol_name_sizes;
6254
6255 #ifdef USE_BFD
6256     /* The symbol names comes either from dli_sname,
6257      * or if using BFD, they can come from BFD. */
6258     char** symbol_names;
6259 #endif
6260
6261     /* The source code location information.  Dug out with e.g. BFD. */
6262     char** source_names;
6263     STRLEN* source_name_sizes;
6264     STRLEN* source_lines;
6265
6266     Perl_c_backtrace* bt = NULL;  /* This is what will be returned. */
6267     int got_depth; /* How many frames were returned from backtrace(). */
6268     UV frame_count = 0; /* How many frames we return. */
6269     UV total_bytes = 0; /* The size of the whole returned backtrace. */
6270
6271 #ifdef USE_BFD
6272     bfd_context bfd_ctx;
6273 #endif
6274 #ifdef PERL_DARWIN
6275     atos_context atos_ctx;
6276 #endif
6277
6278     /* Here are probably possibilities for optimizing.  We could for
6279      * example have a struct that contains most of these and then
6280      * allocate |try_depth| of them, saving a bunch of malloc calls.
6281      * Note, however, that |frames| could not be part of that struct
6282      * because backtrace() will want an array of just them.  Also be
6283      * careful about the name strings. */
6284     Newx(raw_frames, try_depth, void*);
6285     Newx(dl_infos, try_depth, Dl_info);
6286     Newx(object_name_sizes, try_depth, STRLEN);
6287     Newx(symbol_name_sizes, try_depth, STRLEN);
6288     Newx(source_names, try_depth, char*);
6289     Newx(source_name_sizes, try_depth, STRLEN);
6290     Newx(source_lines, try_depth, STRLEN);
6291 #ifdef USE_BFD
6292     Newx(symbol_names, try_depth, char*);
6293 #endif
6294
6295     /* Get the raw frames. */
6296     got_depth = (int)backtrace(raw_frames, try_depth);
6297
6298     /* We use dladdr() instead of backtrace_symbols() because we want
6299      * the full details instead of opaque strings.  This is useful for
6300      * two reasons: () the details are needed for further symbolic
6301      * digging, for example in OS X (2) by having the details we fully
6302      * control the output, which in turn is useful when more platforms
6303      * are added: we can keep out output "portable". */
6304
6305     /* We want a single linear allocation, which can then be freed
6306      * with a single swoop.  We will do the usual trick of first
6307      * walking over the structure and seeing how much we need to
6308      * allocate, then allocating, and then walking over the structure
6309      * the second time and populating it. */
6310
6311     /* First we must compute the total size of the buffer. */
6312     total_bytes = sizeof(Perl_c_backtrace_header);
6313     if (got_depth > skip) {
6314         int i;
6315 #ifdef USE_BFD
6316         bfd_init(); /* Is this safe to call multiple times? */
6317         Zero(&bfd_ctx, 1, bfd_context);
6318 #endif
6319 #ifdef PERL_DARWIN
6320         Zero(&atos_ctx, 1, atos_context);
6321 #endif
6322         for (i = skip; i < try_depth; i++) {
6323             Dl_info* dl_info = &dl_infos[i];
6324
6325             object_name_sizes[i] = 0;
6326             source_names[i] = NULL;
6327             source_name_sizes[i] = 0;
6328             source_lines[i] = 0;
6329
6330             /* Yes, zero from dladdr() is failure. */
6331             if (dladdr(raw_frames[i], dl_info)) {
6332                 total_bytes += sizeof(Perl_c_backtrace_frame);
6333
6334                 object_name_sizes[i] =
6335                     dl_info->dli_fname ? strlen(dl_info->dli_fname) : 0;
6336                 symbol_name_sizes[i] =
6337                     dl_info->dli_sname ? strlen(dl_info->dli_sname) : 0;
6338 #ifdef USE_BFD
6339                 bfd_update(&bfd_ctx, dl_info);
6340                 bfd_symbolize(&bfd_ctx, raw_frames[i],
6341                               &symbol_names[i],
6342                               &symbol_name_sizes[i],
6343                               &source_names[i],
6344                               &source_name_sizes[i],
6345                               &source_lines[i]);
6346 #endif
6347 #if PERL_DARWIN
6348                 atos_update(&atos_ctx, dl_info);
6349                 atos_symbolize(&atos_ctx,
6350                                raw_frames[i],
6351                                &source_names[i],
6352                                &source_name_sizes[i],
6353                                &source_lines[i]);
6354 #endif
6355
6356                 /* Plus ones for the terminating \0. */
6357                 total_bytes += object_name_sizes[i] + 1;
6358                 total_bytes += symbol_name_sizes[i] + 1;
6359                 total_bytes += source_name_sizes[i] + 1;
6360
6361                 frame_count++;
6362             } else {
6363                 break;
6364             }
6365         }
6366 #ifdef USE_BFD
6367         Safefree(bfd_ctx.bfd_syms);
6368 #endif
6369     }
6370
6371     /* Now we can allocate and populate the result buffer. */
6372     Newxc(bt, total_bytes, char, Perl_c_backtrace);
6373     Zero(bt, total_bytes, char);
6374     bt->header.frame_count = frame_count;
6375     bt->header.total_bytes = total_bytes;
6376     if (frame_count > 0) {
6377         Perl_c_backtrace_frame* frame = bt->frame_info;
6378         char* name_base = (char *)(frame + frame_count);
6379         char* name_curr = name_base; /* Outputting the name strings here. */
6380         UV i;
6381         for (i = skip; i < skip + frame_count; i++) {
6382             Dl_info* dl_info = &dl_infos[i];
6383
6384             frame->addr = raw_frames[i];
6385             frame->object_base_addr = dl_info->dli_fbase;
6386             frame->symbol_addr = dl_info->dli_saddr;
6387
6388             /* Copies a string, including the \0, and advances the name_curr.
6389              * Also copies the start and the size to the frame. */
6390 #define PERL_C_BACKTRACE_STRCPY(frame, doffset, src, dsize, size) \
6391             if (size && src) \
6392                 Copy(src, name_curr, size, char); \
6393             frame->doffset = name_curr - (char*)bt; \
6394             frame->dsize = size; \
6395             name_curr += size; \
6396             *name_curr++ = 0;
6397
6398             PERL_C_BACKTRACE_STRCPY(frame, object_name_offset,
6399                                     dl_info->dli_fname,
6400                                     object_name_size, object_name_sizes[i]);
6401
6402 #ifdef USE_BFD
6403             PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6404                                     symbol_names[i],
6405                                     symbol_name_size, symbol_name_sizes[i]);
6406             Safefree(symbol_names[i]);
6407 #else
6408             PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6409                                     dl_info->dli_sname,
6410                                     symbol_name_size, symbol_name_sizes[i]);
6411 #endif
6412
6413             PERL_C_BACKTRACE_STRCPY(frame, source_name_offset,
6414                                     source_names[i],
6415                                     source_name_size, source_name_sizes[i]);
6416             Safefree(source_names[i]);
6417
6418 #undef PERL_C_BACKTRACE_STRCPY
6419
6420             frame->source_line_number = source_lines[i];
6421
6422             frame++;
6423         }
6424         assert(total_bytes ==
6425                (UV)(sizeof(Perl_c_backtrace_header) +
6426                     frame_count * sizeof(Perl_c_backtrace_frame) +
6427                     name_curr - name_base));
6428     }
6429 #ifdef USE_BFD
6430     Safefree(symbol_names);
6431     if (bfd_ctx.abfd) {
6432         bfd_close(bfd_ctx.abfd);
6433     }
6434 #endif
6435     Safefree(source_lines);
6436     Safefree(source_name_sizes);
6437     Safefree(source_names);
6438     Safefree(symbol_name_sizes);
6439     Safefree(object_name_sizes);
6440     /* Assuming the strings returned by dladdr() are pointers
6441      * to read-only static memory (the object file), so that
6442      * they do not need freeing (and cannot be). */
6443     Safefree(dl_infos);
6444     Safefree(raw_frames);
6445     return bt;
6446 #else
6447     PERL_UNUSED_ARGV(depth);
6448     PERL_UNUSED_ARGV(skip);
6449     return NULL;
6450 #endif
6451 }
6452
6453 /*
6454 =for apidoc free_c_backtrace
6455
6456 Deallocates a backtrace received from get_c_bracktrace.
6457
6458 =cut
6459 */
6460
6461 /*
6462 =for apidoc get_c_backtrace_dump
6463
6464 Returns a SV containing a dump of C<depth> frames of the call stack, skipping
6465 the C<skip> innermost ones.  C<depth> of 20 is usually enough.
6466
6467 The appended output looks like:
6468
6469 ...
6470 1   10e004812:0082   Perl_croak   util.c:1716    /usr/bin/perl
6471 2   10df8d6d2:1d72   perl_parse   perl.c:3975    /usr/bin/perl
6472 ...
6473
6474 The fields are tab-separated.  The first column is the depth (zero
6475 being the innermost non-skipped frame).  In the hex:offset, the hex is
6476 where the program counter was in C<S_parse_body>, and the :offset (might
6477 be missing) tells how much inside the C<S_parse_body> the program counter was.
6478
6479 The C<util.c:1716> is the source code file and line number.
6480
6481 The F</usr/bin/perl> is obvious (hopefully).
6482
6483 Unknowns are C<"-">.  Unknowns can happen unfortunately quite easily:
6484 if the platform doesn't support retrieving the information;
6485 if the binary is missing the debug information;
6486 if the optimizer has transformed the code by for example inlining.
6487
6488 =cut
6489 */
6490
6491 SV*
6492 Perl_get_c_backtrace_dump(pTHX_ int depth, int skip)
6493 {
6494     Perl_c_backtrace* bt;
6495
6496     bt = get_c_backtrace(depth, skip + 1 /* Hide ourselves. */);
6497     if (bt) {
6498         Perl_c_backtrace_frame* frame;
6499         SV* dsv = newSVpvs("");
6500         UV i;
6501         for (i = 0, frame = bt->frame_info;
6502              i < bt->header.frame_count; i++, frame++) {
6503             Perl_sv_catpvf(aTHX_ dsv, "%d", (int)i);
6504             Perl_sv_catpvf(aTHX_ dsv, "\t%p", frame->addr ? frame->addr : "-");
6505             /* Symbol (function) names might disappear without debug info.
6506              *
6507              * The source code location might disappear in case of the
6508              * optimizer inlining or otherwise rearranging the code. */
6509             if (frame->symbol_addr) {
6510                 Perl_sv_catpvf(aTHX_ dsv, ":%04x",
6511                                (int)
6512                                ((char*)frame->addr - (char*)frame->symbol_addr));
6513             }
6514             Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6515                            frame->symbol_name_size &&
6516                            frame->symbol_name_offset ?
6517                            (char*)bt + frame->symbol_name_offset : "-");
6518             if (frame->source_name_size &&
6519                 frame->source_name_offset &&
6520                 frame->source_line_number) {
6521                 Perl_sv_catpvf(aTHX_ dsv, "\t%s:%" UVuf,
6522                                (char*)bt + frame->source_name_offset,
6523                                (UV)frame->source_line_number);
6524             } else {
6525                 Perl_sv_catpvf(aTHX_ dsv, "\t-");
6526             }
6527             Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6528                            frame->object_name_size &&
6529                            frame->object_name_offset ?
6530                            (char*)bt + frame->object_name_offset : "-");
6531             /* The frame->object_base_addr is not output,
6532              * but it is used for symbolizing/symbolicating. */
6533             sv_catpvs(dsv, "\n");
6534         }
6535
6536         Perl_free_c_backtrace(bt);
6537
6538         return dsv;
6539     }
6540
6541     return NULL;
6542 }
6543
6544 /*
6545 =for apidoc dump_c_backtrace
6546
6547 Dumps the C backtrace to the given C<fp>.
6548
6549 Returns true if a backtrace could be retrieved, false if not.
6550
6551 =cut
6552 */
6553
6554 bool
6555 Perl_dump_c_backtrace(pTHX_ PerlIO* fp, int depth, int skip)
6556 {
6557     SV* sv;
6558
6559     PERL_ARGS_ASSERT_DUMP_C_BACKTRACE;
6560
6561     sv = Perl_get_c_backtrace_dump(aTHX_ depth, skip);
6562     if (sv) {
6563         sv_2mortal(sv);
6564         PerlIO_printf(fp, "%s", SvPV_nolen(sv));
6565         return TRUE;
6566     }
6567     return FALSE;
6568 }
6569
6570 #endif /* #ifdef USE_C_BACKTRACE */
6571
6572 #ifdef PERL_TSA_ACTIVE
6573
6574 /* pthread_mutex_t and perl_mutex are typedef equivalent
6575  * so casting the pointers is fine. */
6576
6577 int perl_tsa_mutex_lock(perl_mutex* mutex)
6578 {
6579     return pthread_mutex_lock((pthread_mutex_t *) mutex);
6580 }
6581
6582 int perl_tsa_mutex_unlock(perl_mutex* mutex)
6583 {
6584     return pthread_mutex_unlock((pthread_mutex_t *) mutex);
6585 }
6586
6587 int perl_tsa_mutex_destroy(perl_mutex* mutex)
6588 {
6589     return pthread_mutex_destroy((pthread_mutex_t *) mutex);
6590 }
6591
6592 #endif
6593
6594
6595 #ifdef USE_DTRACE
6596
6597 /* log a sub call or return */
6598
6599 void
6600 Perl_dtrace_probe_call(pTHX_ CV *cv, bool is_call)
6601 {
6602     const char *func;
6603     const char *file;
6604     const char *stash;
6605     const COP  *start;
6606     line_t      line;
6607
6608     PERL_ARGS_ASSERT_DTRACE_PROBE_CALL;
6609
6610     if (CvNAMED(cv)) {
6611         HEK *hek = CvNAME_HEK(cv);
6612         func = HEK_KEY(hek);
6613     }
6614     else {
6615         GV  *gv = CvGV(cv);
6616         func = GvENAME(gv);
6617     }
6618     start = (const COP *)CvSTART(cv);
6619     file  = CopFILE(start);
6620     line  = CopLINE(start);
6621     stash = CopSTASHPV(start);
6622
6623     if (is_call) {
6624         PERL_SUB_ENTRY(func, file, line, stash);
6625     }
6626     else {
6627         PERL_SUB_RETURN(func, file, line, stash);
6628     }
6629 }
6630
6631
6632 /* log a require file loading/loaded  */
6633
6634 void
6635 Perl_dtrace_probe_load(pTHX_ const char *name, bool is_loading)
6636 {
6637     PERL_ARGS_ASSERT_DTRACE_PROBE_LOAD;
6638
6639     if (is_loading) {
6640         PERL_LOADING_FILE(name);
6641     }
6642     else {
6643         PERL_LOADED_FILE(name);
6644     }
6645 }
6646
6647
6648 /* log an op execution */
6649
6650 void
6651 Perl_dtrace_probe_op(pTHX_ const OP *op)
6652 {
6653     PERL_ARGS_ASSERT_DTRACE_PROBE_OP;
6654
6655     PERL_OP_ENTRY(OP_NAME(op));
6656 }
6657
6658
6659 /* log a compile/run phase change */
6660
6661 void
6662 Perl_dtrace_probe_phase(pTHX_ enum perl_phase phase)
6663 {
6664     const char *ph_old = PL_phase_names[PL_phase];
6665     const char *ph_new = PL_phase_names[phase];
6666
6667     PERL_PHASE_CHANGE(ph_new, ph_old);
6668 }
6669
6670 #endif
6671
6672 /*
6673  * ex: set ts=8 sts=4 sw=4 et:
6674  */