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